Open Journal Systems  3.3.0
IssueGalleyForm Class Reference
Inheritance diagram for IssueGalleyForm:
Form

Public Member Functions

 __construct ($request, $issue, $issueGalley=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 initData ()
 
 readInputData ()
 
 validate ($callHooks=true)
 
- 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)
 

Data Fields

 $_issue = null
 
 $_issueGalley = null
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Issue galley editing form.

See also
IssueGalley

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

Constructor & Destructor Documentation

◆ __construct()

IssueGalleyForm::__construct (   $request,
  $issue,
  $issueGalley = null 
)

Constructor.

Parameters
$issueIssue
$issueGalleyIssueGalley (optional)

Definition at line 37 of file IssueGalleyForm.inc.php.

References Form\addCheck(), and AppLocale\requireComponents().

Member Function Documentation

◆ execute()

IssueGalleyForm::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 157 of file IssueGalleyForm.inc.php.

References $_issueGalley, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().

◆ fetch()

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

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Definition at line 67 of file IssueGalleyForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

IssueGalleyForm::initData ( )

Initialize form data from current galley (if applicable).

Reimplemented from Form.

Definition at line 126 of file IssueGalleyForm.inc.php.

◆ readInputData()

IssueGalleyForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 142 of file IssueGalleyForm.inc.php.

References Form\readUserVars().

◆ validate()

IssueGalleyForm::validate (   $callHooks = true)

Validate form data.

Parameters
$callHooksboolean True (default) iff hooks are to be called.

Reimplemented from Form.

Definition at line 87 of file IssueGalleyForm.inc.php.

References Form\addError(), Form\addErrorField(), PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().

Field Documentation

◆ $_issue

Issue IssueGalleyForm::$_issue = null

the issue the galley belongs to

Definition at line 24 of file IssueGalleyForm.inc.php.

◆ $_issueGalley

IssueGalley IssueGalleyForm::$_issueGalley = null

current galley

Definition at line 30 of file IssueGalleyForm.inc.php.

Referenced by execute().


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