Public Member Functions | |
| __construct ($request, $submission, $publication, $articleGalley=null) | |
| execute (... $functionArgs) | |
| fetch ($request, $template=null, $display=false) | |
| initData () | |
| readInputData () | |
| validate ($callHooks=true) | |
 Public Member Functions inherited from Form | |
| _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) | |
Data Fields | |
| $_articleGalley = null | |
| $_publication = null | |
| $_submission = null | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Article galley editing form.
- See also
- ArticleGalley
Definition at line 19 of file ArticleGalleyForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ArticleGalleyForm::__construct | ( | $request, | |
| $submission, | |||
| $publication, | |||
$articleGalley = null |
|||
| ) |
Constructor.
- Parameters
-
$submission Submission $publication Publication $articleGalley ArticleGalley (optional)
Reimplemented from Form.
Definition at line 44 of file ArticleGalleyForm.inc.php.
References Form\addCheck(), and AppLocale\requireComponents().
Member Function Documentation
◆ execute()
| ArticleGalleyForm::execute | ( | $functionArgs | ) |
Save changes to the galley.
- Returns
- ArticleGalley The resulting article galley.
Reimplemented from Form.
Definition at line 150 of file ArticleGalleyForm.inc.php.
References $_articleGalley, DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| ArticleGalleyForm::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 75 of file ArticleGalleyForm.inc.php.
References PKPTemplateManager\getManager().
◆ initData()
| ArticleGalleyForm::initData | ( | ) |
Initialize form data from current galley (if applicable).
Reimplemented from Form.
Definition at line 119 of file ArticleGalleyForm.inc.php.
◆ readInputData()
| ArticleGalleyForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 135 of file ArticleGalleyForm.inc.php.
References Form\readUserVars().
◆ validate()
| ArticleGalleyForm::validate | ( | $callHooks = true | ) |
Validate form data.
- Parameters
-
$callHooks boolean True (default) iff hooks are to be called.
Reimplemented from Form.
Definition at line 95 of file ArticleGalleyForm.inc.php.
References Form\addError(), Form\addErrorField(), PKPApplication\get(), and Form\getData().
Field Documentation
◆ $_articleGalley
| ArticleGalley ArticleGalleyForm::$_articleGalley = null |
◆ $_publication
| Publication ArticleGalleyForm::$_publication = null |
Definition at line 30 of file ArticleGalleyForm.inc.php.
◆ $_submission
| Submission ArticleGalleyForm::$_submission = null |
Definition at line 24 of file ArticleGalleyForm.inc.php.
The documentation for this class was generated from the following file:
