Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SubscriptionManagerHandler Class Reference
Inheritance diagram for SubscriptionManagerHandler:
Handler PKPHandler

Public Member Functions

 createSubscription ($args)
 
 createSubscriptionType ()
 
 createUser ($args=array())
 
 deleteSubscription ($args)
 
 deleteSubscriptionType ($args)
 
 editSubscription ($args)
 
 editSubscriptionType ($args=array())
 
 moveSubscriptionType ($args)
 
 payments ($args)
 
 payMethodSettings ()
 
 renewSubscription ($args)
 
 savePaymentSettings ($args)
 
 savePayMethodSettings ()
 
 saveSubscriptionPolicies ($args, &$request)
 
 selectSubscriber ($args)
 
 setupTemplate ($subclass=false, $institutional=false)
 
 SubscriptionManagerHandler ()
 
 subscriptionPolicies ($args, &$request)
 
 subscriptions ($args)
 
 subscriptionsSummary ()
 
 subscriptionTypes ()
 
 suggestUsername ()
 
 updateSubscription ($args)
 
 updateSubscriptionType ()
 
 updateUser ()
 
 viewPayment ($args)
 
 viewPayments ($args)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for subscription management functions.

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

Member Function Documentation

SubscriptionManagerHandler::createSubscription (   $args)

Display form to create new subscription.

Definition at line 151 of file SubscriptionManagerHandler.inc.php.

References editSubscription().

SubscriptionManagerHandler::createSubscriptionType ( )

Display form to create new subscription type.

Definition at line 273 of file SubscriptionManagerHandler.inc.php.

References editSubscriptionType().

SubscriptionManagerHandler::createUser (   $args = array())

Display form to create a user profile.

Parameters
$argsarray optional

Definition at line 327 of file SubscriptionManagerHandler.inc.php.

References Request\getJournal(), setupTemplate(), Request\url(), and PKPHandler\validate().

SubscriptionManagerHandler::deleteSubscription (   $args)

Delete a subscription.

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

Definition at line 69 of file SubscriptionManagerHandler.inc.php.

References SubscriptionAction\deleteSubscription(), PKPRequest\redirect(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::deleteSubscriptionType (   $args)

Delete a subscription type.

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

Definition at line 241 of file SubscriptionManagerHandler.inc.php.

References SubscriptionAction\deleteSubscriptionType(), PKPRequest\redirect(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::editSubscription (   $args)

Display form to edit a subscription.

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

Definition at line 123 of file SubscriptionManagerHandler.inc.php.

References SubscriptionAction\editSubscription(), PKPRequest\redirect(), setupTemplate(), and PKPHandler\validate().

Referenced by createSubscription().

SubscriptionManagerHandler::editSubscriptionType (   $args = array())

Display form to edit a subscription type.

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

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

References SubscriptionAction\editSubscriptionType(), PKPRequest\redirect(), setupTemplate(), Request\url(), and PKPHandler\validate().

Referenced by createSubscriptionType().

SubscriptionManagerHandler::moveSubscriptionType (   $args)

Rearrange the order of subscription types.

Definition at line 227 of file SubscriptionManagerHandler.inc.php.

References SubscriptionAction\moveSubscriptionType(), PKPRequest\redirect(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::payments (   $args)

Display payments settings form

Definition at line 402 of file SubscriptionManagerHandler.inc.php.

References OJSPaymentAction\payments(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::payMethodSettings ( )

Display form to edit program settings.

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

References OJSPaymentAction\payMethodSettings(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::renewSubscription (   $args)

Renew a subscription.

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

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

References PKPRequest\redirect(), SubscriptionAction\renewSubscription(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::savePaymentSettings (   $args)

Execute the payments form or display it again if there are problems

Definition at line 413 of file SubscriptionManagerHandler.inc.php.

References OJSPaymentAction\savePaymentSettings(), setupTemplate(), Request\url(), and PKPHandler\validate().

SubscriptionManagerHandler::savePayMethodSettings ( )

Save changes to payment settings.

Definition at line 469 of file SubscriptionManagerHandler.inc.php.

References OJSPaymentAction\savePayMethodSettings(), setupTemplate(), Request\url(), and PKPHandler\validate().

SubscriptionManagerHandler::saveSubscriptionPolicies (   $args,
$request 
)

Save subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 315 of file SubscriptionManagerHandler.inc.php.

References SubscriptionAction\saveSubscriptionPolicies(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::selectSubscriber (   $args)

Display a list of users from which to choose a subscriber.

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

References PKPRequest\redirect(), SubscriptionAction\selectSubscriber(), setupTemplate(), and PKPHandler\validate().

SubscriptionManagerHandler::SubscriptionManagerHandler ( )

Constructor

Definition at line 22 of file SubscriptionManagerHandler.inc.php.

References PKPHandler\addCheck().

SubscriptionManagerHandler::subscriptionPolicies (   $args,
$request 
)

Display subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 302 of file SubscriptionManagerHandler.inc.php.

References setupTemplate(), SubscriptionAction\subscriptionPolicies(), and PKPHandler\validate().

SubscriptionManagerHandler::subscriptions (   $args)

Display a list of subscriptions for the current journal.

Definition at line 46 of file SubscriptionManagerHandler.inc.php.

References PKPRequest\redirect(), setupTemplate(), SubscriptionAction\subscriptions(), and PKPHandler\validate().

SubscriptionManagerHandler::subscriptionsSummary ( )

Display subscriptions summary page for the current journal.

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

References setupTemplate(), SubscriptionAction\subscriptionsSummary(), and PKPHandler\validate().

SubscriptionManagerHandler::subscriptionTypes ( )

Display a list of subscription types for the current journal.

Definition at line 212 of file SubscriptionManagerHandler.inc.php.

References setupTemplate(), SubscriptionAction\subscriptionTypes(), and PKPHandler\validate().

SubscriptionManagerHandler::suggestUsername ( )

Get a suggested username, making sure it's not already used by the system. (Poor-man's AJAX.)

Definition at line 493 of file SubscriptionManagerHandler.inc.php.

References PKPRequest\getUserVar(), Validation\suggestUsername(), and PKPHandler\validate().

SubscriptionManagerHandler::updateSubscription (   $args)
SubscriptionManagerHandler::updateSubscriptionType ( )
SubscriptionManagerHandler::updateUser ( )
SubscriptionManagerHandler::viewPayment (   $args)

Display a single Completed payment

Definition at line 447 of file SubscriptionManagerHandler.inc.php.

References setupTemplate(), PKPHandler\validate(), and OJSPaymentAction\viewPayment().

SubscriptionManagerHandler::viewPayments (   $args)

Display all payments previously made

Definition at line 436 of file SubscriptionManagerHandler.inc.php.

References setupTemplate(), PKPHandler\validate(), and OJSPaymentAction\viewPayments().


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