Open Journal Systems  3.3.0
SubscriptionForm Class Reference
Inheritance diagram for SubscriptionForm:
Form IndividualSubscriptionForm InstitutionalSubscriptionForm

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)
 

Detailed Description

Base form class for subscription create/edits.

Definition at line 18 of file SubscriptionForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SubscriptionForm::__construct (   $template,
  $subscriptionId = null 
)

Constructor

Parameters
$templatestring? Template to use for form presentation
$subscriptionIdint 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().

Member Function Documentation

◆ _prepareNotificationEmail()

SubscriptionForm::_prepareNotificationEmail (   $mailTemplateKey)
protected

Internal function to prepare notification email

Parameters
$emailTemplateKeystring

Definition at line 230 of file SubscriptionForm.inc.php.

References PKPApplication\get(), and DAORegistry\getDAO().

Referenced by IndividualSubscriptionForm\execute(), and InstitutionalSubscriptionForm\execute().

◆ execute()

SubscriptionForm::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.

Reimplemented in InstitutionalSubscriptionForm, and IndividualSubscriptionForm.

Definition at line 203 of file SubscriptionForm.inc.php.

References $subscription, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().

◆ fetch()

SubscriptionForm::fetch (   $request,
  $template = null,
  $display = false 
)

Display the form. Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Definition at line 96 of file SubscriptionForm.inc.php.

References PKPTemplateManager\getManager().

◆ initData()

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.

◆ readInputData()

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().

Field Documentation

◆ $subscription

Subscription SubscriptionForm::$subscription

the subscription being created/edited

Definition at line 24 of file SubscriptionForm.inc.php.

Referenced by execute(), and initData().

◆ $subscriptionTypes

array SubscriptionForm::$subscriptionTypes

of subscription types

Definition at line 36 of file SubscriptionForm.inc.php.

◆ $userId

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().

◆ $validCountries

array SubscriptionForm::$validCountries

valid user country values

Definition at line 48 of file SubscriptionForm.inc.php.

◆ $validStatus

array SubscriptionForm::$validStatus

valid subscription status values

Definition at line 42 of file SubscriptionForm.inc.php.


The documentation for this class was generated from the following file: