Public Member Functions | |
| __construct () | |
| 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) | |
Detailed Description
Form for managers to setup subscription policies.
Definition at line 28 of file SubscriptionPolicyForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| SubscriptionPolicyForm::__construct | ( | ) |
Constructor
Definition at line 57 of file SubscriptionPolicyForm.inc.php.
References Form\addCheck(), and AppLocale\requireComponents().
Member Function Documentation
◆ execute()
| SubscriptionPolicyForm::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 166 of file SubscriptionPolicyForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| SubscriptionPolicyForm::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 103 of file SubscriptionPolicyForm.inc.php.
References PKPTemplateManager\getManager(), Application\getPaymentManager(), and Config\getVar().
◆ getLocaleFieldNames()
| SubscriptionPolicyForm::getLocaleFieldNames | ( | ) |
Get the names of the fields for which localized settings are used
- Returns
- array
Reimplemented from Form.
Definition at line 159 of file SubscriptionPolicyForm.inc.php.
◆ initData()
| SubscriptionPolicyForm::initData | ( | ) |
Initialize form data from current subscription policies.
Reimplemented from Form.
Definition at line 121 of file SubscriptionPolicyForm.inc.php.
References PKPApplication\get().
◆ readInputData()
| SubscriptionPolicyForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 146 of file SubscriptionPolicyForm.inc.php.
References Form\addCheck(), and Form\readUserVars().
Field Documentation
◆ $validNumMonthsAfterExpiry
| validNumMonthsAfterExpiry SubscriptionPolicyForm::$validNumMonthsAfterExpiry |
array keys are valid expiry reminder months
Definition at line 46 of file SubscriptionPolicyForm.inc.php.
◆ $validNumMonthsBeforeExpiry
| validNumMonthsBeforeExpiry SubscriptionPolicyForm::$validNumMonthsBeforeExpiry |
array keys are valid expiry reminder months
Definition at line 34 of file SubscriptionPolicyForm.inc.php.
◆ $validNumWeeksAfterExpiry
| validNumWeeksAfterExpiry SubscriptionPolicyForm::$validNumWeeksAfterExpiry |
array keys are valid expiry reminder weeks
Definition at line 52 of file SubscriptionPolicyForm.inc.php.
◆ $validNumWeeksBeforeExpiry
| validNumWeeksBeforeExpiry SubscriptionPolicyForm::$validNumWeeksBeforeExpiry |
array keys are valid expiry reminder weeks
Definition at line 40 of file SubscriptionPolicyForm.inc.php.
The documentation for this class was generated from the following file:
