Inheritance diagram for SwordSettingsForm:

Public Member Functions
	__construct (SwordPlugin $plugin, Context $context)

	execute ()

	fetch ($request)

	initData ()

	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)

	execute (... $functionArgs)

	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)

Protected Attributes
	$_context = null

	$_plugin = null

Additional Inherited Members
Data Fields inherited from Form
	$_checks

	$_data

	$_errors

	$_template

	$cssValidation

	$defaultLocale

	$errorFields

	$errorsArray

	$formSectionErrors

	$requiredLocale

	$supportedLocales

Detailed Description

Form for SWORD plugin settings.

Definition at line 16 of file SwordSettingsForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SwordSettingsForm::__construct	(	SwordPlugin	$plugin,
		Context	$context
	)

Constructor

Parameters

$plugin	SwordPlugin
$context	Context

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

References Plugin\getTemplateResource().

Member Function Documentation

◆ execute()

SwordSettingsForm::execute ( )

Save form.

Definition at line 72 of file SwordSettingsForm.inc.php.

References Form\getData().

◆ fetch()

SwordSettingsForm::fetch ( $request )

Returns a string of the rendered form

Parameters

$request	PKPRequest
$template	string the template to be rendered, mandatory if no template has been specified on class instantiation.
$display	boolean

Returns: string the rendered form

Definition at line 63 of file SwordSettingsForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

SwordSettingsForm::initData ( )

Initialize plugin settings form

Returns: void

Reimplemented from Form.

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

References Form\setData().

◆ readInputData()

SwordSettingsForm::readInputData ( )

Assign form data to user-submitted data

Returns: void

Reimplemented from Form.

Definition at line 54 of file SwordSettingsForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $_context

$_context SwordSettingsForm::$_context = null

protected

Context

Definition at line 21 of file SwordSettingsForm.inc.php.

◆ $_plugin

$_plugin SwordSettingsForm::$_plugin = null

protected

SwordPlugin

Definition at line 27 of file SwordSettingsForm.inc.php.

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

SwordSettingsForm.inc.php

Public Member Functions

Protected Attributes

Additional Inherited Members