OrcidProfileSettingsForm Class Reference

Inheritance diagram for OrcidProfileSettingsForm:

Public Member Functions
	__construct (&$plugin, $contextId)
	execute (... $functionArgs)
	fetch ($request, $template=null, $display=false)
	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)
	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
const	CONFIG_VARS
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for site admins to modify ORCID Profile plugin settings.

Definition at line 20 of file OrcidProfileSettingsForm.inc.php.

Constructor & Destructor Documentation

__construct()

OrcidProfileSettingsForm::__construct	(	&	$plugin,
			$contextId
	)

Constructor

Parameters

$plugin	object
$contextId	int

Definition at line 47 of file OrcidProfileSettingsForm.inc.php.

References $contextId, $plugin, and Form\addCheck().

Member Function Documentation

execute()

OrcidProfileSettingsForm::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 94 of file OrcidProfileSettingsForm.inc.php.

References $contextId, $plugin, and Form\getData().

fetch()

OrcidProfileSettingsForm::fetch	(		$request,
			$template = null,
			$display = false
	)

Fetch the form. 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

Reimplemented from Form.

Definition at line 84 of file OrcidProfileSettingsForm.inc.php.

References PKPTemplateManager\getManager().

initData()

OrcidProfileSettingsForm::initData

(

)

Initialize form data.

Reimplemented from Form.

Definition at line 64 of file OrcidProfileSettingsForm.inc.php.

References $contextId, and $plugin.

readInputData()

OrcidProfileSettingsForm::readInputData

(

)

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 76 of file OrcidProfileSettingsForm.inc.php.

References Form\readUserVars().

Field Documentation

$contextId

$contextId OrcidProfileSettingsForm::$contextId

int

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

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

$plugin

$plugin OrcidProfileSettingsForm::$plugin

object

Definition at line 40 of file OrcidProfileSettingsForm.inc.php.

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

CONFIG_VARS

const OrcidProfileSettingsForm::CONFIG_VARS

Initial value:

= array(
      'orcidProfileAPIPath' => 'string',
      'orcidClientId' => 'string',
      'orcidClientSecret' => 'string',
      'sendMailToAuthorsOnPublication' => 'bool',
      'logLevel' => 'string',
      'isSandBox' => 'bool'
   )

Definition at line 22 of file OrcidProfileSettingsForm.inc.php.

---

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

• OrcidProfileSettingsForm.inc.php