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

Public Member Functions

 __construct ($issue=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getLocaleFieldNames ()
 
 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 ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 

Data Fields

 $issue
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form to create or edit an issue.

See also
Issue

Definition at line 23 of file IssueForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

IssueForm::__construct (   $issue = null)

Constructor.

Parameters
$issueIssue (optional)

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

References $issue, and Form\addCheck().

Member Function Documentation

◆ execute()

IssueForm::execute (   $functionArgs)

Save issue settings.

Reimplemented from Form.

Definition at line 200 of file IssueForm.inc.php.

References $issue, HookRegistry\call(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and AppLocale\getLocale().

◆ fetch()

IssueForm::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 69 of file IssueForm.inc.php.

References AppLocale\getLocale(), and PKPTemplateManager\getManager().

◆ getLocaleFieldNames()

IssueForm::getLocaleFieldNames ( )

Get a list of fields for which localization should be used.

Returns
array

Reimplemented from Form.

Definition at line 61 of file IssueForm.inc.php.

References DAORegistry\getDAO().

◆ initData()

IssueForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

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

References AppLocale\getLocale().

◆ readInputData()

IssueForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 174 of file IssueForm.inc.php.

References Form\addCheck(), and Form\readUserVars().

◆ validate()

IssueForm::validate (   $callHooks = true)

Validate form data.

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

Reimplemented from Form.

Definition at line 105 of file IssueForm.inc.php.

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

Field Documentation

◆ $issue

Issue IssueForm::$issue

current issue

Definition at line 28 of file IssueForm.inc.php.

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


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