Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($template, $subscriptionId=null) | |
execute (... $functionArgs) | |
fetch ($request, $template=null, $display=false) | |
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 () | |
getLocaleFieldNames () | |
getRequiredLocale () | |
getTemplate () | |
isValid () | |
readUserVars ($vars) | |
setData ($key, $value=null) | |
setDefaultFormLocale ($defaultLocale) | |
setTemplate ($template) | |
validate ($callHooks=true) | |
Data Fields | |
$subscription | |
$subscriptionTypes | |
$userId | |
$validCountries | |
$validStatus | |
Data Fields inherited from Form | |
$_checks | |
$_data | |
$_errors | |
$_template | |
$cssValidation | |
$defaultLocale | |
$errorFields | |
$errorsArray | |
$formSectionErrors | |
$requiredLocale | |
$supportedLocales | |
Protected Member Functions | |
_prepareNotificationEmail ($mailTemplateKey) | |
Base form class for subscription create/edits.
Definition at line 18 of file SubscriptionForm.inc.php.
SubscriptionForm::__construct | ( | $template, | |
$subscriptionId = null |
|||
) |
Constructor
$template | string? Template to use for form presentation |
$subscriptionId | int The subscription ID for this subscription; null for new subscription |
Reimplemented in IndividualSubscriptionForm, and InstitutionalSubscriptionForm.
Definition at line 55 of file SubscriptionForm.inc.php.
References $userId, Form\addCheck(), DAORegistry\getDAO(), and SubscriptionDAO\getStatusOptions().
|
protected |
Internal function to prepare notification email
$emailTemplateKey | string |
Definition at line 230 of file SubscriptionForm.inc.php.
References PKPApplication\get(), and DAORegistry\getDAO().
Referenced by IndividualSubscriptionForm\execute(), and InstitutionalSubscriptionForm\execute().
SubscriptionForm::execute | ( | $functionArgs | ) |
Execute the form's action. (Note that it is assumed that the form has already been validated.)
mixed | $functionArgs,... | Arguments from the caller to be passed to the hook consumer |
Reimplemented from Form.
Reimplemented in InstitutionalSubscriptionForm, and IndividualSubscriptionForm.
Definition at line 203 of file SubscriptionForm.inc.php.
References $subscription, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
SubscriptionForm::fetch | ( | $request, | |
$template = null , |
|||
$display = false |
|||
) |
Display the form. Returns a string of the rendered form
$request | PKPRequest |
$template | string the template to be rendered, mandatory if no template has been specified on class instantiation. |
$display | boolean |
Reimplemented from Form.
Definition at line 96 of file SubscriptionForm.inc.php.
References PKPTemplateManager\getManager().
SubscriptionForm::initData | ( | ) |
Initialize form data from current subscription.
Reimplemented from Form.
Reimplemented in InstitutionalSubscriptionForm.
Definition at line 111 of file SubscriptionForm.inc.php.
References $subscription.
SubscriptionForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Reimplemented in InstitutionalSubscriptionForm.
Definition at line 130 of file SubscriptionForm.inc.php.
References Form\addCheck(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and Form\readUserVars().
Subscription SubscriptionForm::$subscription |
the subscription being created/edited
Definition at line 24 of file SubscriptionForm.inc.php.
Referenced by execute(), and initData().
array SubscriptionForm::$subscriptionTypes |
of subscription types
Definition at line 36 of file SubscriptionForm.inc.php.
int SubscriptionForm::$userId |
the user associated with the subscription
Definition at line 30 of file SubscriptionForm.inc.php.
Referenced by InstitutionalSubscriptionForm\__construct(), IndividualSubscriptionForm\__construct(), and __construct().
array SubscriptionForm::$validCountries |
valid user country values
Definition at line 48 of file SubscriptionForm.inc.php.
array SubscriptionForm::$validStatus |
valid subscription status values
Definition at line 42 of file SubscriptionForm.inc.php.