Open Journal Systems  3.3.0
SectionForm Class Reference
Inheritance diagram for SectionForm:
PKPSectionForm Form

Public Member Functions

 __construct ($request, $sectionId=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getLocaleFieldNames ()
 
 initData ()
 
 readInputData ()
 
 validate ($callHooks=true)
 
- Public Member Functions inherited from PKPSectionForm
 __construct ($request, $template, $sectionId=null)
 
 getSectionId ()
 
 setSectionId ($sectionId)
 
- 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)
 

Additional Inherited Members

- Data Fields inherited from PKPSectionForm
 $_imageExtension
 
 $_sectionId
 
 $_sizeArray
 
 $_userId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for adding/editing a section.

Definition at line 18 of file SectionForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SectionForm::__construct (   $request,
  $sectionId = null 
)

Constructor.

Parameters
$requestRequest
$sectionIdint optional

Definition at line 25 of file SectionForm.inc.php.

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

Member Function Documentation

◆ execute()

SectionForm::execute (   $functionArgs)

Save section.

Returns
mixed

Reimplemented from PKPSectionForm.

Definition at line 150 of file SectionForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), PKPSectionForm\getSectionId(), and PKPSectionForm\setSectionId().

◆ fetch()

SectionForm::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 PKPSectionForm.

Definition at line 112 of file SectionForm.inc.php.

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), and PKPSectionForm\getSectionId().

◆ getLocaleFieldNames()

SectionForm::getLocaleFieldNames ( )

Get the names of fields for which localized data is allowed.

Returns
array

Reimplemented from Form.

Definition at line 141 of file SectionForm.inc.php.

References DAORegistry\getDAO().

◆ initData()

SectionForm::initData ( )

Initialize form data from current settings.

Reimplemented from Form.

Definition at line 43 of file SectionForm.inc.php.

References PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), PKPSectionForm\getSectionId(), and Form\setData().

◆ readInputData()

SectionForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from PKPSectionForm.

Definition at line 132 of file SectionForm.inc.php.

References Form\readUserVars().

◆ validate()

SectionForm::validate (   $callHooks = true)

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