crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Activity/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  */
  34
  35 /**
  36  * Class to represent the actions that can be performed on a group of contacts
  37  * used by the search forms.
  38  */
  39 class CRM_Activity_Task {
  40   const
  41     DELETE_ACTIVITIES = 1,
  42     PRINT_ACTIVITIES = 2,
  43     EXPORT_ACTIVITIES = 3,
  44     BATCH_ACTIVITIES = 4,
  45     EMAIL_CONTACTS = 5,
  46     EMAIL_SMS = 6;
  47
  48   /**
  49    * The task array.
  50    *
  51    * @var array
  52    */
  53   static $_tasks = NULL;
  54
  55   /**
  56    * The optional task array.
  57    *
  58    * @var array
  59    */
  60   static $_optionalTasks = NULL;
  61
  62   /**
  63    * These tasks are the core set of tasks that the user can perform.
  64    * on a contact / group of contacts
  65    *
  66    * @return array
  67    *   the set of tasks for a group of contacts
  68    */
  69   public static function &tasks() {
  70     if (!(self::$_tasks)) {
  71       self::$_tasks = array(
  72         1 => array(
  73           'title' => ts('Delete Activities'),
  74           'class' => 'CRM_Activity_Form_Task_Delete',
  75           'result' => FALSE,
  76         ),
  77         2 => array(
  78           'title' => ts('Print Selected Rows'),
  79           'class' => 'CRM_Activity_Form_Task_Print',
  80           'result' => FALSE,
  81         ),
  82         3 => array(
  83           'title' => ts('Export Activities'),
  84           'class' => array(
  85             'CRM_Export_Form_Select',
  86             'CRM_Export_Form_Map',
  87           ),
  88           'result' => FALSE,
  89         ),
  90         4 => array(
  91           'title' => ts('Batch Update Activities Via Profile'),
  92           'class' => array(
  93             'CRM_Activity_Form_Task_PickProfile',
  94             'CRM_Activity_Form_Task_Batch',
  95           ),
  96           'result' => FALSE,
  97         ),
  98         5 => array(
  99           'title' => ts('Send Email to Contacts'),
 100           'class' => array(
 101             'CRM_Activity_Form_Task_PickOption',
 102             'CRM_Activity_Form_Task_Email',
 103           ),
 104           'result' => FALSE,
 105         ),
 106         6 => array(
 107           'title' => ts('Send Reply SMS To Contacts'),
 108           'class' => 'CRM_Activity_Form_Task_SMS',
 109           'result' => FALSE,
 110         ),
 111         7 => array(
 112           'title' => ts('Tag Activities (assign tags)'),
 113           'class' => 'CRM_Activity_Form_Task_AddToTag',
 114           'result' => FALSE,
 115         ),
 116         8 => array(
 117           'title' => ts('Untag Activities (remove tags)'),
 118           'class' => 'CRM_Activity_Form_Task_RemoveFromTag',
 119           'result' => FALSE,
 120         ),
 121       );
 122
 123       $config = CRM_Core_Config::singleton();
 124       if (in_array('CiviCase', $config->enableComponents)) {
 125         if (CRM_Core_Permission::check('access all cases and activities') ||
 126           CRM_Core_Permission::check('access my cases and activities')
 127         ) {
 128           self::$_tasks[6] = array(
 129             'title' => ts('File on Case'),
 130             'class' => 'CRM_Activity_Form_Task_FileOnCase',
 131             'result' => FALSE,
 132           );
 133         }
 134       }
 135
 136       //CRM-4418, check for delete
 137       if (!CRM_Core_Permission::check('delete activities')) {
 138         unset(self::$_tasks[1]);
 139       }
 140     }
 141     CRM_Utils_Hook::searchTasks('activity', self::$_tasks);
 142     asort(self::$_tasks);
 143     return self::$_tasks;
 144   }
 145
 146   /**
 147    * These tasks are the core set of task titles.
 148    * on activity
 149    *
 150    * @return array
 151    *   the set of task titles
 152    */
 153   public static function &taskTitles() {
 154     self::tasks();
 155     $titles = array();
 156     foreach (self::$_tasks as $id => $value) {
 157       $titles[$id] = $value['title'];
 158     }
 159     return $titles;
 160   }
 161
 162   /**
 163    * Show tasks selectively based on the permission level.
 164    * of the user
 165    *
 166    * @param int $permission
 167    *
 168    * @return array
 169    *   set of tasks that are valid for the user
 170    */
 171   public static function &permissionedTaskTitles($permission) {
 172     $tasks = array();
 173     if ($permission == CRM_Core_Permission::EDIT) {
 174       $tasks = self::taskTitles();
 175     }
 176     else {
 177       $tasks = array(
 178         3 => self::$_tasks[3]['title'],
 179       );
 180
 181       //CRM-4418,
 182       if (CRM_Core_Permission::check('delete activities')) {
 183         $tasks[1] = self::$_tasks[1]['title'];
 184       }
 185     }
 186     return $tasks;
 187   }
 188
 189   /**
 190    * These tasks are the core set of tasks that the user can perform.
 191    * on activity
 192    *
 193    * @param int $value
 194    *
 195    * @return array
 196    *   the set of tasks for a group of activity
 197    */
 198   public static function getTask($value) {
 199     self::tasks();
 200     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 201       // make the print task by default
 202       $value = 2;
 203     }
 204     return array(
 205       self::$_tasks[$value]['class'],
 206       self::$_tasks[$value]['result'],
 207     );
 208   }
 209
 210 }