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

Public Member Functions

 __construct ($staticPagesPlugin, $contextId, $staticPageId=null)
 
 execute (... $functionParams)
 
 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
 
 $staticPageId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for press managers to create and modify sidebar blocks

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

Constructor & Destructor Documentation

◆ __construct()

StaticPageForm::__construct (   $staticPagesPlugin,
  $contextId,
  $staticPageId = null 
)

Constructor

Parameters
$staticPagesPluginStaticPagesPlugin The static page plugin
$contextIdint Context ID
$staticPageIdint Static page ID (if any)

Definition at line 44 of file StaticPageForm.inc.php.

References $contextId, $staticPageId, Form\addCheck(), and DAORegistry\getDAO().

Member Function Documentation

◆ execute()

StaticPageForm::execute (   $functionParams)

Save form values into the database

Reimplemented from Form.

Definition at line 110 of file StaticPageForm.inc.php.

References DAORegistry\getDAO(), and Form\getData().

◆ fetch()

StaticPageForm::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 89 of file StaticPageForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

StaticPageForm::initData ( )

Initialize form data from current group group.

Reimplemented from Form.

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

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), and Form\setData().

◆ readInputData()

StaticPageForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 82 of file StaticPageForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $contextId

int StaticPageForm::$contextId

Context (press / journal) ID

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

Referenced by __construct().

◆ $plugin

StaticPagesPlugin StaticPageForm::$plugin

Static pages plugin

Definition at line 36 of file StaticPageForm.inc.php.

◆ $staticPageId

string StaticPageForm::$staticPageId

Static page name

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

Referenced by __construct().


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