Public Member Functions | |
| __construct ($request, $seriesId=null) | |
| execute (... $functionParams) | |
| fetch ($request, $template=null, $display=false) | |
| getSeriesId () | |
| initData () | |
| readInputData () | |
| setSeriesId ($seriesId) | |
| validate ($callHooks=true) | |
 Public Member Functions inherited from PKPSectionForm | |
| __construct ($request, $template, $sectionId=null) | |
| getSectionId () | |
| setSectionId ($sectionId) | |
| 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) | |
Data Fields | |
| $_pressId | |
| Data Fields inherited from PKPSectionForm | |
| $_imageExtension | |
| $_sectionId | |
| $_sizeArray | |
| $_userId | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for adding/edditing a series stores/retrieves from an associative array.
Definition at line 19 of file SeriesForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| SeriesForm::__construct | ( | $request, | |
$seriesId = null |
|||
| ) |
Constructor.
- Parameters
-
$request Request $seriesId int optional
Definition at line 31 of file SeriesForm.inc.php.
References Form\addCheck(), and DAORegistry\getDAO().
Member Function Documentation
◆ execute()
| SeriesForm::execute | ( | $functionParams | ) |
Save series.
Reimplemented from PKPSectionForm.
Definition at line 212 of file SeriesForm.inc.php.
References PKPSectionForm\$_imageExtension, PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), getSeriesId(), and setSeriesId().
◆ fetch()
| SeriesForm::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 PKPSectionForm.
Definition at line 141 of file SeriesForm.inc.php.
References PKPServices\get(), DAORegistry\getDAO(), Form\getData(), PKPTemplateManager\getManager(), and getSeriesId().
◆ getSeriesId()
| SeriesForm::getSeriesId | ( | ) |
Get the series ID for this series.
- Returns
- int
Definition at line 353 of file SeriesForm.inc.php.
References PKPSectionForm\getSectionId().
Referenced by execute(), fetch(), initData(), readInputData(), and validate().
◆ initData()
| SeriesForm::initData | ( | ) |
Initialize form data from current settings.
Reimplemented from Form.
Definition at line 60 of file SeriesForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), and getSeriesId().
◆ readInputData()
| SeriesForm::readInputData | ( | ) |
Assign form data to user-submitted data.
- See also
- Form::readInputData()
Reimplemented from PKPSectionForm.
Definition at line 198 of file SeriesForm.inc.php.
References DAORegistry\getDAO(), getSeriesId(), Form\readUserVars(), and Form\setData().
◆ setSeriesId()
| SeriesForm::setSeriesId | ( | $seriesId | ) |
Set the series ID for this series.
- Parameters
-
$seriesId int
Definition at line 361 of file SeriesForm.inc.php.
References PKPSectionForm\setSectionId().
Referenced by execute().
◆ validate()
| SeriesForm::validate | ( | $callHooks = true | ) |
- See also
- Form::validate()
Reimplemented from Form.
Definition at line 100 of file SeriesForm.inc.php.
References Form\addError(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and getSeriesId().
Field Documentation
◆ $_pressId
| $_pressId SeriesForm::$_pressId |
int
Definition at line 24 of file SeriesForm.inc.php.
The documentation for this class was generated from the following file:
