Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SubscriptionAction Class Reference

Public Member Functions

 createSubscription ($args, $institutional=false)
 
 createSubscriptionType ()
 
 deleteSubscription ($args, $institutional=false)
 
 deleteSubscriptionType ($args)
 
 editSubscription ($args, $institutional=false)
 
 editSubscriptionType ($args)
 
 getDateFieldOptions ()
 
 getIndividualSearchFieldOptions ()
 
 getInstitutionalSearchFieldOptions ()
 
 getSearchFormDuplicateParameters ()
 
 moveSubscriptionType ($args)
 
 renewSubscription ($args, $institutional=false)
 
 saveSubscriptionPolicies ($args, &$request)
 
 selectSubscriber ($args=array(), $institutional=false)
 
 sendOnlinePaymentNotificationEmail (&$subscription, $mailTemplateKey)
 
 subscriptionPolicies ($args, &$request)
 
 subscriptions ($institutional=false)
 
 subscriptionsSummary ()
 
 subscriptionTypes ()
 
 updateSubscription ($args, $institutional=false)
 
 updateSubscriptionType ()
 

Detailed Description

Common actions for subscription management functions.

Definition at line 16 of file SubscriptionAction.inc.php.

Member Function Documentation

SubscriptionAction::createSubscription (   $args,
  $institutional = false 
)

Display form to create new subscription.

Definition at line 255 of file SubscriptionAction.inc.php.

References editSubscription().

SubscriptionAction::createSubscriptionType ( )

Display form to create new subscription type.

Definition at line 494 of file SubscriptionAction.inc.php.

References editSubscriptionType().

SubscriptionAction::deleteSubscription (   $args,
  $institutional = false 
)

Delete a subscription.

Parameters
$argsarray first parameter is the ID of the subscription to delete

Definition at line 169 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), and Request\getJournal().

Referenced by SubscriptionHandler\deleteSubscription(), and SubscriptionManagerHandler\deleteSubscription().

SubscriptionAction::deleteSubscriptionType (   $args)

Delete a subscription type.

Parameters
$argsarray first parameter is the ID of the subscription type to delete

Definition at line 442 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), and Request\getJournal().

Referenced by SubscriptionHandler\deleteSubscriptionType(), and SubscriptionManagerHandler\deleteSubscriptionType().

SubscriptionAction::editSubscription (   $args,
  $institutional = false 
)

Display form to edit a subscription.

Parameters
$argsarray second parameter is the ID of the subscription to edit

Definition at line 210 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), and PKPRequest\getUserVar().

Referenced by createSubscription(), SubscriptionHandler\editSubscription(), and SubscriptionManagerHandler\editSubscription().

SubscriptionAction::editSubscriptionType (   $args)

Display form to edit a subscription type.

Parameters
$argsarray optional, first parameter is the ID of the subscription type to edit

Definition at line 458 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), and PKPRequest\getUserVar().

Referenced by createSubscriptionType(), SubscriptionHandler\editSubscriptionType(), and SubscriptionManagerHandler\editSubscriptionType().

SubscriptionAction::getDateFieldOptions ( )

Get the list of date fields that can be searched.

Returns
array

Definition at line 158 of file SubscriptionAction.inc.php.

Referenced by subscriptions().

SubscriptionAction::getIndividualSearchFieldOptions ( )

Get the list of individual fields that can be searched by contents.

Returns
array

Definition at line 129 of file SubscriptionAction.inc.php.

Referenced by subscriptions().

SubscriptionAction::getInstitutionalSearchFieldOptions ( )

Get the list of institutional fields that can be searched by contents.

Returns
array

Definition at line 142 of file SubscriptionAction.inc.php.

Referenced by subscriptions().

SubscriptionAction::getSearchFormDuplicateParameters ( )

Get the list of parameter names that should be duplicated when displaying the search form (i.e. made available to the template based on supplied user data).

Returns
array

Definition at line 116 of file SubscriptionAction.inc.php.

Referenced by subscriptions().

SubscriptionAction::moveSubscriptionType (   $args)
SubscriptionAction::renewSubscription (   $args,
  $institutional = false 
)

Renew a subscription.

Parameters
$argsarray first parameter is the ID of the subscription to renew

Definition at line 189 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), and Request\getJournal().

Referenced by SubscriptionHandler\renewSubscription(), and SubscriptionManagerHandler\renewSubscription().

SubscriptionAction::saveSubscriptionPolicies (   $args,
$request 
)

Save subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 564 of file SubscriptionAction.inc.php.

References Config\getVar().

Referenced by SubscriptionHandler\saveSubscriptionPolicies(), and SubscriptionManagerHandler\saveSubscriptionPolicies().

SubscriptionAction::selectSubscriber (   $args = array(),
  $institutional = false 
)

Display a list of users from which to choose a subscriber/subscription contact.

Definition at line 262 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), PKPHandler\getRangeInfo(), PKPRequest\getUserVar(), Validation\isJournalManager(), and String\strtoupper().

Referenced by SubscriptionHandler\selectSubscriber(), and SubscriptionManagerHandler\selectSubscriber().

SubscriptionAction::sendOnlinePaymentNotificationEmail ( $subscription,
  $mailTemplateKey 
)

Send notification email to Subscription Manager when online payment is completed.

Definition at line 593 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), and Request\url().

Referenced by OJSPaymentManager\fulfillQueuedPayment().

SubscriptionAction::subscriptionPolicies (   $args,
$request 
)

Display subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 536 of file SubscriptionAction.inc.php.

References Config\getVar().

Referenced by SubscriptionHandler\subscriptionPolicies(), and SubscriptionManagerHandler\subscriptionPolicies().

SubscriptionAction::subscriptionsSummary ( )

Display subscriptions summary page for the current journal.

Definition at line 20 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), and Request\getJournal().

Referenced by SubscriptionHandler\subscriptionsSummary(), and SubscriptionManagerHandler\subscriptionsSummary().

SubscriptionAction::subscriptionTypes ( )

Display a list of subscription types for the current journal.

Definition at line 389 of file SubscriptionAction.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), and PKPHandler\getRangeInfo().

Referenced by SubscriptionHandler\subscriptionTypes(), and SubscriptionManagerHandler\subscriptionTypes().

SubscriptionAction::updateSubscription (   $args,
  $institutional = false 
)
SubscriptionAction::updateSubscriptionType ( )

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