Class: SizeLimitOption

Source Location: /modules/sizelimit/SizeLimitOption.inc

Class SizeLimitOption

Class Overview

This ItemEditOption allows the user to set size limits for an album.

Located in /modules/sizelimit/SizeLimitOption.inc [line 35]

ItemEditOption
   |
   --SizeLimitOption

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From ItemEditOption

ItemEditOption::getAllOptions()

Return all the available option plugins

ItemEditOption::handleRequestAfterEdit()

Let the plugin handle the incoming request. We expect the $item to be locked.

ItemEditOption::isAppropriate()

Is this option appropriate at this time?

ItemEditOption::loadTemplate()

Load the template with data from this plugin

ItemEditOption::requiresProgressBar()

Will this task run so long that it requires a progress bar?

[ Top ]

Method Summary

void	handleRequestAfterEdit()
void	isAppropriate()
void	loadTemplate()
void	requiresProgressBar()
array	_applyToDescendents()	Apply current settings to all qualified subitems

[ Top ]

Methods

handleRequestAfterEdit [line 90]

void handleRequestAfterEdit(

$form, 
&$item, 
&$preferred 
)

Parameters:

	$form:
	&$item:
	&$preferred:

API Tags:

See:

ItemEditOption::handleRequestAfterEdit

Redefinition of:

ItemEditOption::handleRequestAfterEdit(): Let the plugin handle the incoming request. We expect the $item to be locked.

[ Top ]

isAppropriate [line 40]

void isAppropriate(

$item, 
$thumbnail 
)

Parameters:

	$item:
	$thumbnail:

API Tags:

See:

ItemEditOption::isAppropriate

Redefinition of:

ItemEditOption::isAppropriate(): Is this option appropriate at this time?

[ Top ]

loadTemplate [line 47]

void loadTemplate(

&$template, 
&$form, 
$item, 
$thumbnail 
)

Parameters:

	&$template:
	&$form:
	$item:
	$thumbnail:

API Tags:

See:

ItemEditOption::loadTemplate

Redefinition of:

ItemEditOption::loadTemplate(): Load the template with data from this plugin

[ Top ]

requiresProgressBar [line 323]

void requiresProgressBar(

$form 
)

Parameters:

$form:

API Tags:

See:

ItemEditOption::requiresProgressBar

Redefinition of:

ItemEditOption::requiresProgressBar(): Will this task run so long that it requires a progress bar?

[ Top ]

_applyToDescendents [line 223]

array _applyToDescendents(
array
$form, GalleryAlbumItem
$album 
)

Apply current settings to all qualified subitems

Parameters:

array	$form:	of form variables
GalleryAlbumItem	$album:	to apply settings

API Tags:

Return:	GalleryStatus a status code array errors, array warnings
Access:	private

[ Top ]

Documentation generated on Sat, 21 Nov 2009 05:28:25 -0800 by phpDocumentor 1.3.0RC6

	SizeLimit UserInterface

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