CRM/Pledge/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2016
  31  */
  32
  33 /**
  34  * class to represent the actions that can be performed on a group of contacts
  35  * used by the search forms.
  36  */
  37 class CRM_Pledge_Task {
  38   const DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3;
  39
  40   /**
  41    * The task array
  42    *
  43    * @var array
  44    */
  45   static $_tasks = NULL;
  46
  47   /**
  48    * The optional task array
  49    *
  50    * @var array
  51    */
  52   static $_optionalTasks = NULL;
  53
  54   /**
  55    * These tasks are the core set of tasks that the user can perform
  56    * on a contact / group of contacts
  57    *
  58    * @return array
  59    *   the set of tasks for a group of contacts
  60    */
  61   public static function &tasks() {
  62     if (!self::$_tasks) {
  63       self::$_tasks = array(
  64         1 => array(
  65           'title' => ts('Delete pledges'),
  66           'class' => 'CRM_Pledge_Form_Task_Delete',
  67           'result' => FALSE,
  68         ),
  69         2 => array(
  70           'title' => ts('Print selected rows'),
  71           'class' => 'CRM_Pledge_Form_Task_Print',
  72           'result' => FALSE,
  73         ),
  74         3 => array(
  75           'title' => ts('Export pledges'),
  76           'class' => array(
  77             'CRM_Export_Form_Select',
  78             'CRM_Export_Form_Map',
  79           ),
  80           'result' => FALSE,
  81         ),
  82       );
  83
  84       // CRM-4418, check for delete
  85       if (!CRM_Core_Permission::check('delete in CiviPledge')) {
  86         unset(self::$_tasks[1]);
  87       }
  88     }
  89     CRM_Utils_Hook::searchTasks('pledge', self::$_tasks);
  90     asort(self::$_tasks);
  91     return self::$_tasks;
  92   }
  93
  94   /**
  95    * These tasks are the core set of task titles.
  96    *
  97    * @return array
  98    *   the set of task titles
  99    */
 100   public static function &taskTitles() {
 101     self::tasks();
 102     $titles = array();
 103     foreach (self::$_tasks as $id => $value) {
 104       $titles[$id] = $value['title'];
 105     }
 106     return $titles;
 107   }
 108
 109   /**
 110    * These tasks get added based on the context the user is in.
 111    *
 112    * @return array
 113    *   the set of optional tasks for a group of contacts
 114    */
 115   public static function &optionalTaskTitle() {
 116     $tasks = array();
 117     return $tasks;
 118   }
 119
 120   /**
 121    * Show tasks selectively based on the permission level
 122    * of the user
 123    *
 124    * @param int $permission
 125    *
 126    * @return array
 127    *   set of tasks that are valid for the user
 128    */
 129   public static function &permissionedTaskTitles($permission) {
 130     $tasks = array();
 131     if (($permission == CRM_Core_Permission::EDIT)
 132       || CRM_Core_Permission::check('edit pledges')
 133     ) {
 134       $tasks = self::taskTitles();
 135     }
 136     else {
 137       $tasks = array(
 138         3 => self::$_tasks[3]['title'],
 139       );
 140       //CRM-4418,
 141       if (CRM_Core_Permission::check('delete in CiviPledge')) {
 142         $tasks[1] = self::$_tasks[1]['title'];
 143       }
 144     }
 145     return $tasks;
 146   }
 147
 148   /**
 149    * These tasks are the core set of tasks that the user can perform
 150    * on pledges.
 151    *
 152    * @param int $value
 153    *
 154    * @return array
 155    *   the set of tasks for a group of pledge holders
 156    */
 157   public static function getTask($value) {
 158     self::tasks();
 159     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 160       // make the print task by default
 161       $value = 2;
 162     }
 163     return array(
 164       self::$_tasks[$value]['class'],
 165       self::$_tasks[$value]['result'],
 166     );
 167   }
 168
 169 }