Public Member Functions | |
| __construct ($reviewFormId, $reviewFormElementId=null) | |
| deleteEntry ($request, $rowId) | |
| execute (... $functionArgs) | |
| fetch ($request, $template=null, $display=false) | |
| getLocaleFieldNames () | |
| initData () | |
| insertEntry ($request, $newRowId) | |
| readInputData () | |
| updateEntry ($request, $rowId, $newRowId) | |
 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) | |
| validate ($callHooks=true) | |
Data Fields | |
| $reviewFormElementId | |
| $reviewFormId | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for creating and modifying review form elements.
- See also
- ReviewFormElement
Definition at line 21 of file ReviewFormElementForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ReviewFormElementForm::__construct | ( | $reviewFormId, | |
$reviewFormElementId = null |
|||
| ) |
Constructor.
- Parameters
-
$reviewFormId int $reviewFormElementId int
Definition at line 40 of file ReviewFormElementForm.inc.php.
References $reviewFormElementId, $reviewFormId, and Form\addCheck().
Member Function Documentation
◆ deleteEntry()
| ReviewFormElementForm::deleteEntry | ( | $request, | |
| $rowId | |||
| ) |
Delete an entry.
- Parameters
-
$request Request object $rowId mixed ID of row to modify
- Returns
- boolean
Definition at line 169 of file ReviewFormElementForm.inc.php.
References Form\getData(), and Form\setData().
◆ execute()
| ReviewFormElementForm::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.
- int Review form element ID
Reimplemented from Form.
Definition at line 114 of file ReviewFormElementForm.inc.php.
References $reviewFormElementId, fatalError(), PKPApplication\get(), Application\getContextAssocType(), DAORegistry\getDAO(), Form\getData(), ReviewFormElement\getMultipleResponsesElementTypes(), Form\setData(), and ListbuilderHandler\unpack().
◆ fetch()
| ReviewFormElementForm::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 65 of file ReviewFormElementForm.inc.php.
References PKPTemplateManager\getManager(), ReviewFormElement\getMultipleResponsesElementTypes(), and ReviewFormElement\getReviewFormElementTypeOptions().
◆ getLocaleFieldNames()
| ReviewFormElementForm::getLocaleFieldNames | ( | ) |
Get the names of fields for which localized data is allowed.
- Returns
- array
Reimplemented from Form.
Definition at line 57 of file ReviewFormElementForm.inc.php.
References DAORegistry\getDAO().
◆ initData()
| ReviewFormElementForm::initData | ( | ) |
Initialize form data from current review form.
Reimplemented from Form.
Definition at line 81 of file ReviewFormElementForm.inc.php.
References PKPApplication\get(), and DAORegistry\getDAO().
◆ insertEntry()
| ReviewFormElementForm::insertEntry | ( | $request, | |
| $newRowId | |||
| ) |
Persist a new entry insert.
- Parameters
-
$request Request object $newRowId mixed ID of row to modify
- Returns
- boolean
Definition at line 157 of file ReviewFormElementForm.inc.php.
References Form\getData(), and Form\setData().
◆ readInputData()
| ReviewFormElementForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 106 of file ReviewFormElementForm.inc.php.
References Form\readUserVars().
◆ updateEntry()
| ReviewFormElementForm::updateEntry | ( | $request, | |
| $rowId, | |||
| $newRowId | |||
| ) |
Persist an update to an entry.
- Parameters
-
$request Request object $rowId mixed ID of row to modify $newRowId mixed ID of the new entry
- Returns
- boolean
Definition at line 183 of file ReviewFormElementForm.inc.php.
References Form\getData(), and Form\setData().
Field Documentation
◆ $reviewFormElementId
| $reviewFormElementId ReviewFormElementForm::$reviewFormElementId |
int The ID of the review form element being edited
Definition at line 33 of file ReviewFormElementForm.inc.php.
Referenced by __construct(), and execute().
◆ $reviewFormId
| $reviewFormId ReviewFormElementForm::$reviewFormId |
int The ID of the review form being edited
Definition at line 27 of file ReviewFormElementForm.inc.php.
Referenced by __construct().
The documentation for this class was generated from the following file:
