DOAJSettingsForm Class Reference

Inheritance diagram for DOAJSettingsForm:

Public Member Functions
	__construct ($plugin, $contextId)
	_getContextId ()
	_getPlugin ()
	execute (... $functionArgs)
	getFormFields ()
	initData ()
	isOptional ($settingName)
	readInputData ()
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
	$_contextId
	$_plugin
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for journal managers to setup DOAJ plugin.

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

Constructor & Destructor Documentation

__construct()

DOAJSettingsForm::__construct	(		$plugin,
			$contextId
	)

Constructor

Parameters

$plugin	DOAJExportPlugin
$contextId	integer

Definition at line 61 of file DOAJSettingsForm.inc.php.

References Form\addCheck().

Member Function Documentation

_getContextId()

DOAJSettingsForm::_getContextId

(

)

Get the context ID.

Returns

integer

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

References $_contextId.

Referenced by execute(), and initData().

_getPlugin()

DOAJSettingsForm::_getPlugin

(

)

Get the plugin.

Returns

CrossRefExportPlugin

Definition at line 48 of file DOAJSettingsForm.inc.php.

References $_plugin.

Referenced by execute(), and initData().

execute()

DOAJSettingsForm::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 97 of file DOAJSettingsForm.inc.php.

References _getContextId(), _getPlugin(), Form\getData(), and getFormFields().

getFormFields()

DOAJSettingsForm::getFormFields

(

)

Get form fields

Returns

array (field name => field type)

Definition at line 114 of file DOAJSettingsForm.inc.php.

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

initData()

DOAJSettingsForm::initData

(

)

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 79 of file DOAJSettingsForm.inc.php.

References _getContextId(), _getPlugin(), getFormFields(), and Form\setData().

isOptional()

DOAJSettingsForm::isOptional

(

$settingName

)

Is the form field optional

Parameters

$settingName

string

Returns

boolean

Definition at line 127 of file DOAJSettingsForm.inc.php.

readInputData()

DOAJSettingsForm::readInputData

(

)

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from Form.

Definition at line 90 of file DOAJSettingsForm.inc.php.

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

Field Documentation

$_contextId

integer DOAJSettingsForm::$_contextId

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

Referenced by _getContextId().

$_plugin

CrossRefExportPlugin DOAJSettingsForm::$_plugin

Definition at line 42 of file DOAJSettingsForm.inc.php.

Referenced by _getPlugin().

---

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

• DOAJSettingsForm.inc.php