Public Member Functions | |
| __construct ($plugin, $contextId) | |
| _checkPrerequisites () | |
| 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 | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for journal managers to modify PLN plugin settings.
Definition at line 15 of file PLNSettingsForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PLNSettingsForm::__construct | ( | $plugin, | |
| $contextId | |||
| ) |
Constructor
- Parameters
-
$plugin Plugin $contextId int
Definition at line 33 of file PLNSettingsForm.inc.php.
Member Function Documentation
◆ _checkPrerequisites()
| PLNSettingsForm::_checkPrerequisites | ( | ) |
Check for the prerequisites for the plugin, and return a translated message for each missing requirement.
- Returns
- array
Definition at line 72 of file PLNSettingsForm.inc.php.
◆ execute()
| PLNSettingsForm::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 118 of file PLNSettingsForm.inc.php.
References DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| PLNSettingsForm::fetch | ( | $request, | |
$template = null, |
|||
$display = false |
|||
| ) |
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 90 of file PLNSettingsForm.inc.php.
References PKPTemplateManager\getManager().
◆ initData()
| PLNSettingsForm::initData | ( | ) |
Initialize form data for a new form.
Reimplemented from Form.
Definition at line 42 of file PLNSettingsForm.inc.php.
References $_contextId, and Form\setData().
◆ readInputData()
| PLNSettingsForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Definition at line 54 of file PLNSettingsForm.inc.php.
References Form\getData(), Form\readUserVars(), and Form\setData().
Field Documentation
◆ $_contextId
| int PLNSettingsForm::$_contextId |
Definition at line 20 of file PLNSettingsForm.inc.php.
Referenced by initData().
◆ $_plugin
| Plugin PLNSettingsForm::$_plugin |
Definition at line 26 of file PLNSettingsForm.inc.php.
The documentation for this class was generated from the following file:
