Public Member Functions | |
| __construct ($journalId, $typeId=null) | |
| execute (... $functionArgs) | |
| fetch ($request, $template=null, $display=false) | |
| getLocaleFieldNames () | |
| 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) | |
| getData ($key) | |
| getDefaultFormLocale () | |
| getErrorsArray () | |
| getRequiredLocale () | |
| getTemplate () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $journalId | |
| $typeId | |
| $validCurrencies | |
| $validFormats | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form for journal managers to create/edit subscription types.
Definition at line 18 of file SubscriptionTypeForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| SubscriptionTypeForm::__construct | ( | $journalId, | |
$typeId = null |
|||
| ) |
Constructor
- Parameters
-
$journalId int Journal ID typeId int leave as default for new subscription type
Definition at line 48 of file SubscriptionTypeForm.inc.php.
References $journalId, $typeId, and Form\addCheck().
Member Function Documentation
◆ execute()
| SubscriptionTypeForm::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 156 of file SubscriptionTypeForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| SubscriptionTypeForm::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 105 of file SubscriptionTypeForm.inc.php.
References PKPTemplateManager\getManager().
◆ getLocaleFieldNames()
| SubscriptionTypeForm::getLocaleFieldNames | ( | ) |
Get a list of localized field names for this form
- Returns
- array
Reimplemented from Form.
Definition at line 97 of file SubscriptionTypeForm.inc.php.
References DAORegistry\getDAO().
◆ initData()
| SubscriptionTypeForm::initData | ( | ) |
Initialize form data from current subscription type.
Reimplemented from Form.
Definition at line 118 of file SubscriptionTypeForm.inc.php.
References DAORegistry\getDAO().
◆ readInputData()
| SubscriptionTypeForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 145 of file SubscriptionTypeForm.inc.php.
References Form\addCheck(), and Form\readUserVars().
Field Documentation
◆ $journalId
| $journalId SubscriptionTypeForm::$journalId |
int Journal ID
Definition at line 41 of file SubscriptionTypeForm.inc.php.
Referenced by __construct().
◆ $typeId
| $typeId SubscriptionTypeForm::$typeId |
int the ID of the subscription type being edited
Definition at line 23 of file SubscriptionTypeForm.inc.php.
Referenced by __construct().
◆ $validCurrencies
| $validCurrencies SubscriptionTypeForm::$validCurrencies |
array keys are valid subscription type currencies
Definition at line 35 of file SubscriptionTypeForm.inc.php.
◆ $validFormats
| $validFormats SubscriptionTypeForm::$validFormats |
array keys are valid subscription type formats
Definition at line 29 of file SubscriptionTypeForm.inc.php.
The documentation for this class was generated from the following file:
