CRM/Pledge/Task.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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2018
  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     }
  92
  93     return self::$_tasks;
  94   }
  95
  96   /**
  97    * These tasks are the core set of task titles.
  98    *
  99    * @return array
 100    *   the set of task titles
 101    */
 102   public static function &taskTitles() {
 103     self::tasks();
 104     $titles = array();
 105     foreach (self::$_tasks as $id => $value) {
 106       $titles[$id] = $value['title'];
 107     }
 108     return $titles;
 109   }
 110
 111   /**
 112    * These tasks get added based on the context the user is in.
 113    *
 114    * @return array
 115    *   the set of optional tasks for a group of contacts
 116    */
 117   public static function &optionalTaskTitle() {
 118     $tasks = array();
 119     return $tasks;
 120   }
 121
 122   /**
 123    * Show tasks selectively based on the permission level
 124    * of the user
 125    *
 126    * @param int $permission
 127    *
 128    * @return array
 129    *   set of tasks that are valid for the user
 130    */
 131   public static function &permissionedTaskTitles($permission) {
 132     $tasks = array();
 133     if (($permission == CRM_Core_Permission::EDIT)
 134       || CRM_Core_Permission::check('edit pledges')
 135     ) {
 136       $tasks = self::taskTitles();
 137     }
 138     else {
 139       $tasks = array(
 140         3 => self::$_tasks[3]['title'],
 141       );
 142       //CRM-4418,
 143       if (CRM_Core_Permission::check('delete in CiviPledge')) {
 144         $tasks[1] = self::$_tasks[1]['title'];
 145       }
 146     }
 147     return $tasks;
 148   }
 149
 150   /**
 151    * These tasks are the core set of tasks that the user can perform
 152    * on pledges.
 153    *
 154    * @param int $value
 155    *
 156    * @return array
 157    *   the set of tasks for a group of pledge holders
 158    */
 159   public static function getTask($value) {
 160     self::tasks();
 161     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 162       // make the print task by default
 163       $value = 2;
 164     }
 165     return array(
 166       self::$_tasks[$value]['class'],
 167       self::$_tasks[$value]['result'],
 168     );
 169   }
 170
 171 }