Public Member Functions | |
| __construct ($contextId, $navigationMenuItemId) | |
| execute (... $functionParams) | |
| fetch ($request, $template=null, $display=false) | |
| getContextId () | |
| 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 | |
| $_contextId | |
| $navigationMenuItemId | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for managers to create/edit navigationMenuItems.
Definition at line 19 of file PKPNavigationMenuItemsForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKPNavigationMenuItemsForm::__construct | ( | $contextId, | |
| $navigationMenuItemId | |||
| ) |
Constructor
- Parameters
-
$contextId int $navigationMenuItemId int
Definition at line 37 of file PKPNavigationMenuItemsForm.inc.php.
References $navigationMenuItemId, and Form\addCheck().
Member Function Documentation
◆ execute()
| PKPNavigationMenuItemsForm::execute | ( | $functionParams | ) |
Save NavigationMenuItem.
Reimplemented from Form.
Definition at line 159 of file PKPNavigationMenuItemsForm.inc.php.
References PKPServices\get(), getContextId(), DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| PKPNavigationMenuItemsForm::fetch | ( | $request, | |
$template = null, |
|||
$display = false |
|||
| ) |
Returns a string of the rendered form
- Parameters
-
$request PKPRequest $template string the template to be rendered, mandatory if no template has been specified on class instantiation. $display boolean
- Returns
- string the rendered form
Reimplemented from Form.
Definition at line 68 of file PKPNavigationMenuItemsForm.inc.php.
References PKPServices\get(), PKPTemplateManager\getManager(), and AppLocale\requireComponents().
◆ getContextId()
| PKPNavigationMenuItemsForm::getContextId | ( | ) |
Get the current context id.
- Returns
- int
Definition at line 56 of file PKPNavigationMenuItemsForm.inc.php.
References $_contextId.
Referenced by execute().
◆ getLocaleFieldNames()
| PKPNavigationMenuItemsForm::getLocaleFieldNames | ( | ) |
Get the list of field names that need to support multiple locales
- Returns
- array
Reimplemented from Form.
Definition at line 151 of file PKPNavigationMenuItemsForm.inc.php.
References DAORegistry\getDAO().
◆ initData()
| PKPNavigationMenuItemsForm::initData | ( | ) |
Initialize form data from current navigation menu item.
Reimplemented from Form.
Definition at line 119 of file PKPNavigationMenuItemsForm.inc.php.
References PKPServices\get(), DAORegistry\getDAO(), and Form\setData().
◆ readInputData()
| PKPNavigationMenuItemsForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 144 of file PKPNavigationMenuItemsForm.inc.php.
References Form\readUserVars().
◆ validate()
| PKPNavigationMenuItemsForm::validate | ( | $callHooks = true | ) |
Perform additional validation checks Validate form data.
- Parameters
-
$callHooks boolean True (default) iff hooks are to be called.
Reimplemented from Form.
Definition at line 214 of file PKPNavigationMenuItemsForm.inc.php.
References Form\addError(), DAORegistry\getDAO(), and Form\getData().
Field Documentation
◆ $_contextId
| int PKPNavigationMenuItemsForm::$_contextId |
Definition at line 30 of file PKPNavigationMenuItemsForm.inc.php.
Referenced by getContextId().
◆ $navigationMenuItemId
| $navigationMenuItemId PKPNavigationMenuItemsForm::$navigationMenuItemId |
int the ID of the navigationMenuItem
Definition at line 24 of file PKPNavigationMenuItemsForm.inc.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
