PHP Class SubscriptionForm, ojs

Inheritance: extends Form
Show file Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$subscription the subscription being created/edited
$subscriptionTypes of subscription types
$userId the user associated with the subscription
$validCountries valid user country values
$validStatus valid subscription status values

Public Methods

Method Description
__construct ( $template, $subscriptionId = null, $userId = null ) Constructor
_prepareNotificationEmail ( $mailTemplateKey ) Internal function to prepare notification email
display ( ) Display the form.
execute ( ) Save subscription.
initData ( ) Initialize form data from current subscription.
readInputData ( ) Assign form data to user-submitted data.

Method Details

__construct() public method

Constructor
public __construct ( $template, $subscriptionId = null, $userId = null )
$template string? Template to use for form presentation
$subscriptionId int The subscription ID for this subscription; null for new subscription
$userId int The user ID for this subscription; null for new subscription

_prepareNotificationEmail() public method

Internal function to prepare notification email
public _prepareNotificationEmail ( $mailTemplateKey )

display() public method

Display the form.
public display ( )

execute() public method

Save subscription.
public execute ( )

initData() public method

Initialize form data from current subscription.
public initData ( )

readInputData() public method

Assign form data to user-submitted data.
public readInputData ( )

Property Details

$subscription public property

the subscription being created/edited
public $subscription

$subscriptionTypes public property

of subscription types
public $subscriptionTypes

$userId public property

the user associated with the subscription
public $userId

$validCountries public property

valid user country values
public $validCountries

$validStatus public property

valid subscription status values
public $validStatus