Class: HiddenInterface_1_0

Source Location: /modules/hidden/classes/HiddenInterface_1_0.class

Class HiddenInterface_1_0

Class Overview

This is an interface for the hidden module. Modules that wish to create hidden items can utilize an implementation of this interface.

Located in /modules/hidden/classes/HiddenInterface_1_0.class [line 39]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
HiddenHelper	Helper functions for hiding/unhiding and changing permissions.

[ Top ]

Method Summary

GalleryStatus	hideItem()	Hide an item
array	isHidden()	Is item hidden?
GalleryStatus	unHideItem()	Unhide an item

[ Top ]

Methods

hideItem [line 48]

GalleryStatus hideItem(

&$item, [boolean
$useProgressBar = false], GalleryItem
$item 
)

Hide an item

Parameters:

GalleryItem	$item:
boolean	$useProgressBar:	(default is false)
	&$item:

API Tags:

Return:

a status code

Redefined in descendants as:

HiddenHelper::hideItem() : Hides an item.

[ Top ]

isHidden [line 70]

array isHidden(
GalleryItem
$item 
)

Is item hidden?

Parameters:

GalleryItem

$item:

API Tags:

Return:

GalleryStatus a status code boolean true if hidden

Redefined in descendants as:

HiddenHelper::isHidden()

[ Top ]

unHideItem [line 59]

GalleryStatus unHideItem(

&$item, [boolean
$useProgressBar = false], GalleryItem
$item 
)

Unhide an item

Parameters:

GalleryItem	$item:
boolean	$useProgressBar:	(default is false)
	&$item:

API Tags:

Return:

a status code

Redefined in descendants as:

HiddenHelper::unHideItem() : Remove the hiding of the item by adding back core.view permissions to either anonymous user or everybody group if they have either core.viewResizes or core.viewSource.

[ Top ]

Documentation generated on Sat, 21 Nov 2009 04:53:43 -0800 by phpDocumentor 1.3.0RC6

	Hidden Classes

[ class tree: Hidden ] [ index: Hidden ] [ all elements ]