CRM/Admin/Page/ScheduleReminders.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 /**
  35  * Page for displaying list of Reminders.
  36  */
  37 class CRM_Admin_Page_ScheduleReminders extends CRM_Core_Page_Basic {
  38
  39   public $useLivePageJS = TRUE;
  40
  41   /**
  42    * The action links that we need to display for the browse screen.
  43    *
  44    * @var array
  45    */
  46   static $_links = NULL;
  47
  48   /**
  49    * Get BAO Name.
  50    *
  51    * @return string
  52    *   Classname of BAO.
  53    */
  54   public function getBAOName() {
  55     return 'CRM_Core_BAO_ActionSchedule';
  56   }
  57
  58   /**
  59    * Get action Links.
  60    *
  61    * @return array
  62    *   (reference) of action links
  63    */
  64   public function &links() {
  65     if (!(self::$_links)) {
  66       // helper variable for nicer formatting
  67       self::$_links = array(
  68         CRM_Core_Action::UPDATE => array(
  69           'name' => ts('Edit'),
  70           'url' => 'civicrm/admin/scheduleReminders',
  71           'qs' => 'action=update&id=%%id%%&reset=1',
  72           'title' => ts('Edit Schedule Reminders'),
  73         ),
  74         CRM_Core_Action::ENABLE => array(
  75           'name' => ts('Enable'),
  76           'ref' => 'crm-enable-disable',
  77           'title' => ts('Enable Label Format'),
  78         ),
  79         CRM_Core_Action::DISABLE => array(
  80           'name' => ts('Disable'),
  81           'ref' => 'crm-enable-disable',
  82           'title' => ts('Disable Label Format'),
  83         ),
  84         CRM_Core_Action::DELETE => array(
  85           'name' => ts('Delete'),
  86           'url' => 'civicrm/admin/scheduleReminders',
  87           'qs' => 'action=delete&id=%%id%%',
  88           'title' => ts('Delete Schedule Reminders'),
  89         ),
  90       );
  91     }
  92
  93     return self::$_links;
  94   }
  95
  96   /**
  97    * Get name of edit form.
  98    *
  99    * @return string
 100    *   Classname of edit form.
 101    */
 102   public function editForm() {
 103     return 'CRM_Admin_Form_ScheduleReminders';
 104   }
 105
 106   /**
 107    * Get edit form name.
 108    *
 109    * @return string
 110    *   name of this page.
 111    */
 112   public function editName() {
 113     return 'ScheduleReminders';
 114   }
 115
 116   /**
 117    * Get user context.
 118    *
 119    * @param null $mode
 120    *
 121    * @return string
 122    *   user context.
 123    */
 124   public function userContext($mode = NULL) {
 125     return 'civicrm/admin/scheduleReminders';
 126   }
 127
 128   /**
 129    * Browse all Scheduled Reminders settings.
 130    *
 131    * @param null $action
 132    */
 133   public function browse($action = NULL) {
 134     //CRM-16777: Do not permit access to user, for page 'Administer->Communication->Schedule Reminder',
 135     //when do not have 'administer CiviCRM' permission.
 136     if (!CRM_Core_Permission::check('administer CiviCRM')) {
 137       CRM_Core_Error::fatal(ts('You do not have permission to access this page.'));
 138     }
 139
 140     // Get list of configured reminders
 141     $reminderList = CRM_Core_BAO_ActionSchedule::getList();
 142
 143     if (is_array($reminderList)) {
 144       // Add action links to each of the reminders
 145       foreach ($reminderList as & $format) {
 146         $action = array_sum(array_keys($this->links()));
 147         if ($format['is_active']) {
 148           $action -= CRM_Core_Action::ENABLE;
 149         }
 150         else {
 151           $action -= CRM_Core_Action::DISABLE;
 152         }
 153         $format['action'] = CRM_Core_Action::formLink(
 154           self::links(),
 155           $action,
 156           array('id' => $format['id']),
 157           ts('more'),
 158           FALSE,
 159           'actionSchedule.manage.action',
 160           'ActionSchedule',
 161           $format['id']
 162         );
 163       }
 164     }
 165
 166     $this->assign('rows', $reminderList);
 167   }
 168
 169 }