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