Open Journal Systems  3.3.0
UserInstitutionalSubscriptionForm Class Reference
Inheritance diagram for UserInstitutionalSubscriptionForm:
Form

Public Member Functions

 __construct ($request, $userId=null, $subscriptionId=null)
 
 display ($request=null, $template=null)
 
 execute (... $functionArgs)
 
 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)
 
 fetch ($request, $template=null, $display=false)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $request
 
 $subscription
 
 $subscriptionTypes
 
 $userId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form class for user purchase of institutional subscription.

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

Constructor & Destructor Documentation

◆ __construct()

UserInstitutionalSubscriptionForm::__construct (   $request,
  $userId = null,
  $subscriptionId = null 
)

Constructor

Parameters
$requestPKPRequest
$userIdint
$subscriptionIdint

Definition at line 49 of file UserInstitutionalSubscriptionForm.inc.php.

References $request, $subscriptionTypes, $userId, Form\addCheck(), and DAORegistry\getDAO().

Member Function Documentation

◆ display()

UserInstitutionalSubscriptionForm::display (   $request = null,
  $template = null 
)

Display the form.

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

Reimplemented from Form.

Definition at line 110 of file UserInstitutionalSubscriptionForm.inc.php.

References $request, and PKPTemplateManager\getManager().

◆ execute()

UserInstitutionalSubscriptionForm::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 171 of file UserInstitutionalSubscriptionForm.inc.php.

References $subscription, DAORegistry\getDAO(), Form\getData(), Application\getPaymentManager(), and PKPString\regexp_split().

◆ initData()

UserInstitutionalSubscriptionForm::initData ( )

Initialize form data from current subscription.

Reimplemented from Form.

Definition at line 95 of file UserInstitutionalSubscriptionForm.inc.php.

References $subscription.

◆ readInputData()

UserInstitutionalSubscriptionForm::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Definition at line 125 of file UserInstitutionalSubscriptionForm.inc.php.

References Form\addCheck(), DAORegistry\getDAO(), Form\getData(), Form\readUserVars(), PKPString\regexp_match(), and PKPString\regexp_split().

Field Documentation

◆ $request

PKPRequest UserInstitutionalSubscriptionForm::$request

Definition at line 23 of file UserInstitutionalSubscriptionForm.inc.php.

Referenced by __construct(), and display().

◆ $subscription

subscription UserInstitutionalSubscriptionForm::$subscription

the subscription being purchased

Definition at line 35 of file UserInstitutionalSubscriptionForm.inc.php.

Referenced by execute(), and initData().

◆ $subscriptionTypes

subscriptionTypes UserInstitutionalSubscriptionForm::$subscriptionTypes

Array subscription types

Definition at line 41 of file UserInstitutionalSubscriptionForm.inc.php.

Referenced by __construct().

◆ $userId

userId UserInstitutionalSubscriptionForm::$userId

int the user associated with the subscription

Definition at line 29 of file UserInstitutionalSubscriptionForm.inc.php.

Referenced by __construct().


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