SubscriptionHandler Class Reference
[Pages_manager]
Public Member Functions | |
| createSubscription () | |
| createSubscriptionType () | |
| deleteSubscription ($args) | |
| deleteSubscriptionType ($args) | |
| editSubscription ($args=array()) | |
| editSubscriptionType ($args=array()) | |
| getDateFieldOptions () | |
| getSearchFieldOptions () | |
| getSearchFormDuplicateParameters () | |
| moveSubscriptionType ($args) | |
| saveSubscriptionPolicies ($args=array()) | |
| selectSubscriber () | |
| setupTemplate ($subclass=false) | |
| subscriptionPolicies () | |
| subscriptions () | |
| subscriptionTypes () | |
| updateSubscription () | |
| updateSubscriptionType () | |
Detailed Description
Handle requests for subscription management functions.Definition at line 18 of file SubscriptionHandler.inc.php.
Member Function Documentation
| SubscriptionHandler.createSubscription | ( | ) |
Display form to create new subscription.
Reimplemented from ManagerHandler.
Definition at line 159 of file SubscriptionHandler.inc.php.
References editSubscription().
| SubscriptionHandler.createSubscriptionType | ( | ) |
Display form to create new subscription type.
Reimplemented from ManagerHandler.
Definition at line 363 of file SubscriptionHandler.inc.php.
References editSubscriptionType().
| SubscriptionHandler.deleteSubscription | ( | $ | args | ) |
Delete a subscription.
- Parameters:
-
$args array first parameter is the ID of the subscription to delete
Reimplemented from ManagerHandler.
Definition at line 103 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| SubscriptionHandler.deleteSubscriptionType | ( | $ | args | ) |
Delete a subscription type.
- Parameters:
-
$args array first parameter is the ID of the subscription type to delete
Reimplemented from ManagerHandler.
Definition at line 303 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().
| SubscriptionHandler.editSubscription | ( | $ | args = array() |
) |
Display form to edit a subscription.
- Parameters:
-
$args array optional, first parameter is the ID of the subscription to edit
Reimplemented from ManagerHandler.
Definition at line 125 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), and Request.url().
Referenced by createSubscription().
| SubscriptionHandler.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
Reimplemented from ManagerHandler.
Definition at line 325 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.redirect(), setupTemplate(), and Request.url().
Referenced by createSubscriptionType().
| SubscriptionHandler.getDateFieldOptions | ( | ) |
Get the list of date fields that can be searched.
- Returns:
- array
Definition at line 92 of file SubscriptionHandler.inc.php.
Referenced by subscriptions().
| SubscriptionHandler.getSearchFieldOptions | ( | ) |
Get the list of fields that can be searched by contents.
- Returns:
- array
Definition at line 79 of file SubscriptionHandler.inc.php.
Referenced by subscriptions().
| SubscriptionHandler.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 66 of file SubscriptionHandler.inc.php.
Referenced by subscriptions().
| SubscriptionHandler.moveSubscriptionType | ( | $ | args | ) |
Rearrange the order of subscription types.
Reimplemented from ManagerHandler.
Definition at line 280 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), Request.getUserVar(), and Request.redirect().
| SubscriptionHandler.saveSubscriptionPolicies | ( | $ | args = array() |
) |
Save subscription policies for the current journal.
Reimplemented from ManagerHandler.
Definition at line 451 of file SubscriptionHandler.inc.php.
References TemplateManager.getManager(), Config.getVar(), setupTemplate(), and ManagerHandler.validate().
| SubscriptionHandler.selectSubscriber | ( | ) |
Display a list of users from which to choose a subscriber.
Definition at line 166 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getUserVar(), setupTemplate(), String.strtoupper(), Locale.translate(), and Request.url().
| SubscriptionHandler.setupTemplate | ( | $ | subclass = false |
) |
Setup common template variables.
- Parameters:
-
$subclass boolean set to true if caller is below this handler in the hierarchy
Reimplemented from ManagerHandler.
Definition at line 485 of file SubscriptionHandler.inc.php.
References TemplateManager.getManager(), and Request.url().
Referenced by editSubscription(), editSubscriptionType(), saveSubscriptionPolicies(), selectSubscriber(), subscriptionPolicies(), subscriptions(), subscriptionTypes(), updateSubscription(), and updateSubscriptionType().
| SubscriptionHandler.subscriptionPolicies | ( | ) |
Display subscription policies for the current journal.
Reimplemented from ManagerHandler.
Definition at line 426 of file SubscriptionHandler.inc.php.
References TemplateManager.getManager(), Config.getVar(), and setupTemplate().
| SubscriptionHandler.subscriptions | ( | ) |
Display a list of subscriptions for the current journal.
Reimplemented from ManagerHandler.
Definition at line 23 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), getDateFieldOptions(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), getSearchFieldOptions(), getSearchFormDuplicateParameters(), Request.getUserDateVar(), Request.getUserVar(), and setupTemplate().
| SubscriptionHandler.subscriptionTypes | ( | ) |
Display a list of subscription types for the current journal.
Reimplemented from ManagerHandler.
Definition at line 261 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), and setupTemplate().
| SubscriptionHandler.updateSubscription | ( | ) |
Save changes to a subscription.
Definition at line 215 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and ManagerHandler.validate().
| SubscriptionHandler.updateSubscriptionType | ( | ) |
Save changes to a subscription type.
Definition at line 370 of file SubscriptionHandler.inc.php.
References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), setupTemplate(), Request.url(), and ManagerHandler.validate().
The documentation for this class was generated from the following file:
- pages/manager/SubscriptionHandler.inc.php
