Docs For Class HiddenHelper

Methods

Constructor HiddenHelper [line 531]

HiddenHelper HiddenHelper(
)

[ Top ]

handleMoveItem [line 483]

GalleryStatus handleMoveItem(
GalleryItem
$item 
)

Update permissions as needed for appropriate hidden status when moving an item.

Parameters:

GalleryItem

$item:

item that has moved

API Tags:

Return:

a status code

[ Top ]

hideItem [line 54]

GalleryStatus hideItem(

&$item, [boolean
$useProgressBar = false], [int
$hideId = null], [int
$hiddenAncestor = null], [int
$passwordAncestor = null], GalleryItem
$item 
)

Hides an item.

Remove public view permission (core.view for anonymous user or everybody group) and add session based permission for core.view. Add an onLoadHandler that will grant this permission to the session when core.ShowItem view is directly accessed for this item. If an album, cascades the effects to all contained items that aren't already hidden. Thus all contents of the album are hidden and become visible when the album is accessed.

Parameters:

GalleryItem	$item:	the item to be hidden
boolean	$useProgressBar:	(default is false)
int	$hideId:	used in recursive calls
int	$hiddenAncestor:	used in recursive calls
int	$passwordAncestor:	used in recursive calls
	&$item:

API Tags:

Return:

a status code

Redefinition of:

HiddenInterface_1_0::hideItem(): Hide an item

[ Top ]

isHidden [line 527]

void isHidden(

$item 
)

Parameters:

$item:

API Tags:

See:

HiddenInterface_1_0::isHidden

Redefinition of:

HiddenInterface_1_0::isHidden(): Is item hidden?

[ Top ]

unHideItem [line 241]

GalleryStatus unHideItem(

&$item, [boolean
$useProgressBar = false], [int
$hideId = null], [int
$hiddenAncestor = null], [int
$passwordAncestor = null], GalleryItem
$item 
)

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.

If an album, cascade the effects to all child items that are not hidden themselves.

Parameters:

GalleryItem	$item:	the item to unhide
boolean	$useProgressBar:	(default is false)
int	$hideId:	used in recursive calls
int	$hiddenAncestor:	used in recursive calls
int	$passwordAncestor:	used in recursive calls
	&$item:

API Tags:

Return:

a status code

Redefinition of:

HiddenInterface_1_0::unHideItem(): Unhide an item

[ Top ]

_checkAncestors [line 454]

array _checkAncestors(
GalleryItem
$item, mixed
$passwordInterface 
)

Check for nearest hidden/password ancestor of given item

Parameters:

GalleryItem	$item:
mixed	$passwordInterface:	instance of PasswordInterface or false

API Tags:

Return:	GalleryStatus a status code mixed id of nearest hidden ancestor or false mixed id of nearest password protected ancestor or false
Access:	private

[ Top ]

	Hidden Classes

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

Class: HiddenHelper

Class HiddenHelper