SubscriptionManagerHandler Class Reference
[Pages_subscriptionManager]

Handle requests for subscription management functions. More...

Inheritance diagram for SubscriptionManagerHandler:

List of all members.

Public Member Functions
	createSubscription ()
	createSubscriptionType ()
	createUser ($args=array())
	deleteSubscription ($args)
	deleteSubscriptionType ($args)
	editSubscription ($args=array())
	editSubscriptionType ($args=array())
	getDateFieldOptions ()
	getSearchFieldOptions ()
	getSearchFormDuplicateParameters ()
	index ()
	moveSubscriptionType ($args)
	saveSubscriptionPolicies ($args=array())
	selectSubscriber ()
	setupTemplate ($subclass=false)
	subscriptionPolicies ()
	subscriptions ()
	subscriptionTypes ()
	updateSubscription ()
	updateSubscriptionType ()
	updateUser ()
	validate ()

---

Detailed Description

Handle requests for subscription management functions.

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

---

Member Function Documentation

SubscriptionManagerHandler.createSubscription

(

)

Display form to create new subscription.

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

References editSubscription().

SubscriptionManagerHandler.createSubscriptionType

(

)

Display form to create new subscription type.

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

References editSubscriptionType().

SubscriptionManagerHandler.createUser

(

$

args = array()

)

Display form to create a user profile.

Parameters:

$args

array optional

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

References Request.getJournal(), TemplateManager.getManager(), setupTemplate(), Request.url(), and validate().

SubscriptionManagerHandler.deleteSubscription

(

$

args

)

Delete a subscription.

Parameters:

$args

array first parameter is the ID of the subscription to delete

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

References DAORegistry.getDAO(), Request.getJournal(), Request.redirect(), and validate().

SubscriptionManagerHandler.deleteSubscriptionType

(

$

args

)

Delete a subscription type.

Parameters:

$args

array first parameter is the ID of the subscription type to delete

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

References DAORegistry.getDAO(), Request.getJournal(), Request.redirect(), and validate().

SubscriptionManagerHandler.editSubscription

(

$

args = array()

)

Display form to edit a subscription.

Parameters:

$args

array optional, first parameter is the ID of the subscription to edit

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and validate().

Referenced by createSubscription().

SubscriptionManagerHandler.editSubscriptionType

(

$

args = array()

)

Display form to edit a subscription type.

Parameters:

$args

array optional, first parameter is the ID of the subscription type to edit

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.redirect(), setupTemplate(), Request.url(), and validate().

Referenced by createSubscriptionType().

SubscriptionManagerHandler.getDateFieldOptions

(

)

Get the list of date fields that can be searched.

Returns:

array

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

Referenced by subscriptions().

SubscriptionManagerHandler.getSearchFieldOptions

(

)

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

Returns:

array

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

Referenced by subscriptions().

SubscriptionManagerHandler.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 69 of file SubscriptionManagerHandler.inc.php.

Referenced by subscriptions().

SubscriptionManagerHandler.index

(

)

Fallback method in case request handler does not implement index method.

Reimplemented from Handler.

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

References subscriptions().

SubscriptionManagerHandler.moveSubscriptionType

(

$

args

)

Rearrange the order of subscription types.

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

References DAORegistry.getDAO(), Request.getJournal(), Request.getUserVar(), Request.redirect(), and validate().

SubscriptionManagerHandler.saveSubscriptionPolicies

(

$

args = array()

)

Save subscription policies for the current journal.

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

References TemplateManager.getManager(), Config.getVar(), setupTemplate(), and validate().

SubscriptionManagerHandler.selectSubscriber

(

)

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

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

References DAORegistry.getDAO(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getUserVar(), setupTemplate(), String.strtoupper(), Locale.translate(), Request.url(), and validate().

SubscriptionManagerHandler.setupTemplate

(

$

subclass = false

)

Setup common template variables.

Parameters:

$subclass

boolean set to true if caller is below this handler in the hierarchy

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

References TemplateManager.getManager(), and Request.url().

Referenced by createUser(), editSubscription(), editSubscriptionType(), saveSubscriptionPolicies(), selectSubscriber(), subscriptionPolicies(), subscriptions(), subscriptionTypes(), updateSubscription(), updateSubscriptionType(), and updateUser().

SubscriptionManagerHandler.subscriptionPolicies

(

)

Display subscription policies for the current journal.

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

References TemplateManager.getManager(), Config.getVar(), setupTemplate(), and validate().

SubscriptionManagerHandler.subscriptions

(

)

Display a list of subscriptions for the current journal.

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

References DAORegistry.getDAO(), getDateFieldOptions(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), getSearchFieldOptions(), getSearchFormDuplicateParameters(), Request.getUserDateVar(), Request.getUserVar(), setupTemplate(), and validate().

Referenced by index().

SubscriptionManagerHandler.subscriptionTypes

(

)

Display a list of subscription types for the current journal.

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), setupTemplate(), and validate().

SubscriptionManagerHandler.updateSubscription

(

)

Save changes to a subscription.

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and validate().

SubscriptionManagerHandler.updateSubscriptionType

(

)

Save changes to a subscription type.

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and validate().

SubscriptionManagerHandler.updateUser

(

)

Save changes to a user profile.

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

References Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and validate().

SubscriptionManagerHandler.validate

(

)

Validate that user has permissions to manage subscriptions for the selected journal. Redirects to user index page if not properly authenticated.

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

References Request.getJournal(), Validation.isSubscriptionManager(), and Validation.redirectLogin().

Referenced by createUser(), deleteSubscription(), deleteSubscriptionType(), editSubscription(), editSubscriptionType(), moveSubscriptionType(), saveSubscriptionPolicies(), selectSubscriber(), subscriptionPolicies(), subscriptions(), subscriptionTypes(), updateSubscription(), updateSubscriptionType(), and updateUser().

---

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

• pages/subscriptionManager/SubscriptionManagerHandler.inc.php