CRM/Grant/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * class to represent the actions that can be performed on a group of contacts
  38  * used by the search forms
  39  *
  40  */
  41 class CRM_Grant_Task {
  42   const DELETE_GRANTS = 1, PRINT_GRANTS = 2, EXPORT_GRANTS = 3, UPDATE_GRANTS = 4;
  43
  44   /**
  45    * The task array
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_tasks = NULL;
  51
  52   /**
  53    * The optional task array
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_optionalTasks = NULL;
  59
  60   /**
  61    * These tasks are the core set of tasks that the user can perform
  62    * on a contact / group of contacts
  63    *
  64    * @return array
  65    *   the set of tasks for a group of contacts
  66    * @static
  67    */
  68   public static function &tasks() {
  69     if (!(self::$_tasks)) {
  70       self::$_tasks = array(
  71       1 => array(
  72         'title' => ts('Delete Grants'),
  73           'class' => 'CRM_Grant_Form_Task_Delete',
  74           'result' => FALSE,
  75         ),
  76         2 => array(
  77           'title' => ts('Print Selected Rows'),
  78           'class' => 'CRM_Grant_Form_Task_Print',
  79           'result' => FALSE,
  80         ),
  81         3 => array(
  82           'title' => ts('Export Grants'),
  83           'class' => array(
  84             'CRM_Export_Form_Select',
  85             'CRM_Export_Form_Map',
  86           ),
  87           'result' => FALSE,
  88         ),
  89         4 => array(
  90           'title' => ts('Update Grants'),
  91           'class' => 'CRM_Grant_Form_Task_Update',
  92           'result' => FALSE,
  93         ),
  94       );
  95     }
  96     if (!CRM_Core_Permission::check('delete in CiviGrant')) {
  97       unset(self::$_tasks[1]);
  98     }
  99     CRM_Utils_Hook::searchTasks('grant', self::$_tasks);
 100     asort(self::$_tasks);
 101     return self::$_tasks;
 102   }
 103
 104   /**
 105    * These tasks are the core set of task titles
 106    *
 107    * @return array
 108    *   the set of task titles
 109    * @static
 110    */
 111   public static function &taskTitles() {
 112     self::tasks();
 113     $titles = array();
 114     foreach (self::$_tasks as $id => $value) {
 115       $titles[$id] = $value['title'];
 116     }
 117     return $titles;
 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 grants')
 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 CiviGrant')) {
 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    *
 151    * @param int $value
 152    *
 153    * @return array
 154    *   the set of tasks for a group of contacts
 155    * @static
 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 }