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

Public Member Functions

 __construct ($template, $contextId, $plugin=null)
 
 execute (... $functionArgs)
 
 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)
 
 fetch ($request, $template=null, $display=false)
 
 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
 
- 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 CustomBlockForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

CustomBlockForm::__construct (   $template,
  $contextId,
  $plugin = null 
)

Constructor

Parameters
$templatestring the path to the form template file
$contextIdint
$pluginCustomBlockPlugin

Definition at line 38 of file CustomBlockForm.inc.php.

References $contextId, $plugin, and Form\addCheck().

Member Function Documentation

◆ execute()

CustomBlockForm::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 80 of file CustomBlockForm.inc.php.

References $contextId, $plugin, Form\getData(), and PluginRegistry\getPlugin().

◆ initData()

CustomBlockForm::initData ( )

Initialize form data from current group group.

Reimplemented from Form.

Definition at line 54 of file CustomBlockForm.inc.php.

References $contextId, $plugin, PKPTemplateManager\getManager(), and Form\setData().

◆ readInputData()

CustomBlockForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 73 of file CustomBlockForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $contextId

int CustomBlockForm::$contextId

Context (press / journal) ID

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

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

◆ $plugin

CustomBlockPlugin CustomBlockForm::$plugin

Custom block plugin

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

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


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