BrowseBlockSettingsForm Class Reference

Inheritance diagram for BrowseBlockSettingsForm:

Public Member Functions
	__construct ($plugin, $pressId)
	_getFormFields ()
	execute (... $functionArgs)
	getPlugin ()
	getPressId ()
	initData ()
	readInputData ()
	setPlugin ($plugin)
	setPressId ($pressId)
Public Member Functions inherited from Form
	__construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
	_decomposeArray ($name, $value, $stack)
	addCheck ($formValidator)
	addError ($field, $message)
	addErrorField ($field)
	addSupportedFormLocale ($supportedLocale)
	display ($request=null, $template=null)
	fetch ($request, $template=null, $display=false)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_plugin
	$_pressId
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for press managers to setup Browse block plugin.

Definition at line 19 of file BrowseBlockSettingsForm.inc.php.

Constructor & Destructor Documentation

__construct()

BrowseBlockSettingsForm::__construct	(		$plugin,
			$pressId
	)

Constructor

Parameters

$plugin	BrowseBlockPlugin
$pressId	int

Definition at line 45 of file BrowseBlockSettingsForm.inc.php.

References Form\addCheck(), Form\setData(), setPlugin(), and setPressId().

Member Function Documentation

_getFormFields()

BrowseBlockSettingsForm::_getFormFields

(

)

Definition at line 129 of file BrowseBlockSettingsForm.inc.php.

Referenced by execute(), initData(), and readInputData().

execute()

BrowseBlockSettingsForm::execute

(

$functionArgs

)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters

mixed

$functionArgs,...

Arguments from the caller to be passed to the hook consumer

Returns

mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 117 of file BrowseBlockSettingsForm.inc.php.

References _getFormFields(), Form\getData(), getPlugin(), and getPressId().

getPlugin()

BrowseBlockSettingsForm::getPlugin

(

)

Get the plugin.

Returns

BrowseBlockPlugin

Definition at line 81 of file BrowseBlockSettingsForm.inc.php.

References $_plugin.

Referenced by execute(), and initData().

getPressId()

BrowseBlockSettingsForm::getPressId

(

)

Get the Press ID.

Returns

int

Definition at line 65 of file BrowseBlockSettingsForm.inc.php.

References $_pressId.

Referenced by execute(), and initData().

initData()

BrowseBlockSettingsForm::initData

(

)

See also

Form::initData()

Reimplemented from Form.

Definition at line 99 of file BrowseBlockSettingsForm.inc.php.

References _getFormFields(), getPlugin(), getPressId(), and Form\setData().

readInputData()

BrowseBlockSettingsForm::readInputData

(

)

See also

Form::readInputData()

Reimplemented from Form.

Definition at line 110 of file BrowseBlockSettingsForm.inc.php.

References _getFormFields(), and Form\readUserVars().

setPlugin()

BrowseBlockSettingsForm::setPlugin

(

$plugin

)

Set the plugin.

Parameters

$plugin

BrowseBlockPlugin

Definition at line 89 of file BrowseBlockSettingsForm.inc.php.

Referenced by __construct().

setPressId()

BrowseBlockSettingsForm::setPressId

(

$pressId

)

Set the Press ID.

Parameters

$pressId

int

Definition at line 73 of file BrowseBlockSettingsForm.inc.php.

Referenced by __construct().

Field Documentation

$_plugin

BrowseBlockPlugin BrowseBlockSettingsForm::$_plugin

Browse block plugin

Definition at line 34 of file BrowseBlockSettingsForm.inc.php.

Referenced by getPlugin().

$_pressId

int BrowseBlockSettingsForm::$_pressId

press ID

Definition at line 28 of file BrowseBlockSettingsForm.inc.php.

Referenced by getPressId().

---

The documentation for this class was generated from the following file:

• BrowseBlockSettingsForm.inc.php