CRM/Grant/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 the set of tasks for a group of contacts
  65    * @static
  66    * @access public
  67    */
  68   static function &tasks() {
  69     if (!(self::$_tasks)) {
  70       self::$_tasks = array(1 => array(
  71         'title' => ts('Delete Grants'),
  72           'class' => 'CRM_Grant_Form_Task_Delete',
  73           'result' => FALSE,
  74         ),
  75         2 => array(
  76           'title' => ts('Print Selected Rows'),
  77           'class' => 'CRM_Grant_Form_Task_Print',
  78           'result' => FALSE,
  79         ),
  80         3 => array(
  81           'title' => ts('Export Grants'),
  82           'class' => array(
  83             'CRM_Export_Form_Select',
  84             'CRM_Export_Form_Map',
  85           ),
  86           'result' => FALSE,
  87         ),
  88         4 => array(
  89           'title' => ts('Update Grants'),
  90           'class' => 'CRM_Grant_Form_Task_Update',
  91           'result' => FALSE,
  92         ),
  93       );
  94     }
  95     if (!CRM_Core_Permission::check('delete in CiviGrant')) {
  96       unset(self::$_tasks[1]);
  97     }
  98     CRM_Utils_Hook::searchTasks('grant', self::$_tasks);
  99     asort(self::$_tasks);
 100     return self::$_tasks;
 101   }
 102
 103   /**
 104    * These tasks are the core set of task titles
 105    *
 106    * @return array the set of task titles
 107    * @static
 108    * @access public
 109    */
 110   static function &taskTitles() {
 111     self::tasks();
 112     $titles = array();
 113     foreach (self::$_tasks as $id => $value) {
 114       $titles[$id] = $value['title'];
 115     }
 116     return $titles;
 117   }
 118
 119   /**
 120    * show tasks selectively based on the permission level
 121    * of the user
 122    *
 123    * @param int $permission
 124    *
 125    * @return array set of tasks that are valid for the user
 126    * @access public
 127    */
 128   static function &permissionedTaskTitles($permission) {
 129     $tasks = array();
 130     if (($permission == CRM_Core_Permission::EDIT)
 131       || CRM_Core_Permission::check('edit grants')
 132     ) {
 133       $tasks = self::taskTitles();
 134     }
 135     else {
 136       $tasks = array(
 137         3 => self::$_tasks[3]['title'],
 138       );
 139       //CRM-4418,
 140       if (CRM_Core_Permission::check('delete in CiviGrant')) {
 141         $tasks[1] = self::$_tasks[1]['title'];
 142       }
 143     }
 144     return $tasks;
 145   }
 146
 147   /**
 148    * These tasks are the core set of tasks that the user can perform
 149    *
 150    * @param int $value
 151    *
 152    * @return array the set of tasks for a group of contacts
 153    * @static
 154    * @access public
 155    */
 156   static function getTask($value) {
 157     self::tasks();
 158     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 159       // make the print task by default
 160       $value = 2;
 161     }
 162     return array(
 163       self::$_tasks[$value]['class'],
 164       self::$_tasks[$value]['result'],
 165     );
 166   }
 167 }
 168