Open Journal Systems  3.3.0
PKPNotificationSettingsForm Class Reference
Inheritance diagram for PKPNotificationSettingsForm:
Form NotificationSettingsForm

Public Member Functions

 __construct ()
 
 execute (... $functionParams)
 
 fetch ($request, $template=null, $display=false)
 
 getNotificationSettingCategories ()
 
 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 ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Protected Member Functions

 getNotificationSettingsMap ()
 

Additional Inherited Members

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

Detailed Description

Form to edit notification settings.

Definition at line 22 of file PKPNotificationSettingsForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPNotificationSettingsForm::__construct ( )

Constructor.

Definition at line 26 of file PKPNotificationSettingsForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

PKPNotificationSettingsForm::execute (   $functionParams)

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 146 of file PKPNotificationSettingsForm.inc.php.

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

◆ fetch()

PKPNotificationSettingsForm::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 128 of file PKPNotificationSettingsForm.inc.php.

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

◆ getNotificationSettingCategories()

PKPNotificationSettingsForm::getNotificationSettingCategories ( )

Get a list of notification category names (to display as headers) and the notification types under each category

Returns
array

Reimplemented in NotificationSettingsForm.

Definition at line 89 of file PKPNotificationSettingsForm.inc.php.

References HookRegistry\call(), and strtolower_codesafe().

◆ getNotificationSettingsMap()

PKPNotificationSettingsForm::getNotificationSettingsMap ( )
protected

Get all notification settings form names and their setting type values

Returns
array

Reimplemented in NotificationSettingsForm.

Definition at line 51 of file PKPNotificationSettingsForm.inc.php.

References HookRegistry\call(), and strtolower_codesafe().

Referenced by execute(), and readInputData().

◆ readInputData()

PKPNotificationSettingsForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

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

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


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