CRM/Member/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * class to represent the actions that can be performed on a group of
  38  * contacts (CiviMember)
  39  * used by the search forms
  40  *
  41  */
  42 class CRM_Member_Task extends CRM_Core_Task {
  43   const
  44     // Member tasks
  45     LABEL_MEMBERS = 201;
  46
  47   static $objectType = 'membership';
  48
  49   /**
  50    * These tasks are the core set of tasks that the user can perform
  51    * on a contact / group of contacts
  52    *
  53    * @return array
  54    *   the set of tasks for a group of contacts
  55    */
  56   public static function tasks() {
  57     if (!self::$_tasks) {
  58       self::$_tasks = array(
  59         self::TASK_DELETE => array(
  60           'title' => ts('Delete memberships'),
  61           'class' => 'CRM_Member_Form_Task_Delete',
  62           'result' => FALSE,
  63         ),
  64         self::TASK_PRINT => array(
  65           'title' => ts('Print selected rows'),
  66           'class' => 'CRM_Member_Form_Task_Print',
  67           'result' => FALSE,
  68         ),
  69         self::TASK_EXPORT => array(
  70           'title' => ts('Export members'),
  71           'class' => array(
  72             'CRM_Export_Form_Select',
  73             'CRM_Export_Form_Map',
  74           ),
  75           'result' => FALSE,
  76         ),
  77         self::TASK_EMAIL => array(
  78           'title' => ts('Email - send now (to %1 or less)', array(
  79             1 => Civi::settings()
  80               ->get('simple_mail_limit'),
  81           )),
  82           'class' => 'CRM_Member_Form_Task_Email',
  83           'result' => TRUE,
  84         ),
  85         self::BATCH_UPDATE => array(
  86           'title' => ts('Update multiple memberships'),
  87           'class' => array(
  88             'CRM_Member_Form_Task_PickProfile',
  89             'CRM_Member_Form_Task_Batch',
  90           ),
  91           'result' => TRUE,
  92         ),
  93         self::LABEL_MEMBERS => array(
  94           'title' => ts('Mailing labels - print'),
  95           'class' => array(
  96             'CRM_Member_Form_Task_Label',
  97           ),
  98           'result' => TRUE,
  99         ),
 100         self::PDF_LETTER => array(
 101           'title' => ts('Print/merge document for memberships'),
 102           'class' => 'CRM_Member_Form_Task_PDFLetter',
 103           'result' => FALSE,
 104         ),
 105       );
 106
 107       //CRM-4418, check for delete
 108       if (!CRM_Core_Permission::check('delete in CiviMember')) {
 109         unset(self::$_tasks[self::TASK_DELETE]);
 110       }
 111       //CRM-12920 - check for edit permission
 112       if (!CRM_Core_Permission::check('edit memberships')) {
 113         unset(self::$_tasks[self::BATCH_UPDATE]);
 114       }
 115
 116       parent::tasks();
 117     }
 118
 119     return self::$_tasks;
 120   }
 121
 122   /**
 123    * These tasks are the core set of task titles
 124    * on members
 125    *
 126    * @return array
 127    *   the set of task titles
 128    */
 129   public static function taskTitles() {
 130     return parent::taskTitles();
 131   }
 132
 133   /**
 134    * Show tasks selectively based on the permission level
 135    * of the user
 136    *
 137    * @param int $permission
 138    * @param array $params
 139    *
 140    * @return array
 141    *   set of tasks that are valid for the user
 142    */
 143   public static function permissionedTaskTitles($permission, $params = array()) {
 144     if (($permission == CRM_Core_Permission::EDIT)
 145       || CRM_Core_Permission::check('edit memberships')
 146     ) {
 147       $tasks = self::taskTitles();
 148     }
 149     else {
 150       $tasks = array(
 151         self::TASK_EXPORT => self::$_tasks[self::TASK_EXPORT]['title'],
 152         self::TASK_EMAIL => self::$_tasks[self::TASK_EMAIL]['title'],
 153       );
 154       //CRM-4418,
 155       if (CRM_Core_Permission::check('delete in CiviMember')) {
 156         $tasks[self::TASK_DELETE] = self::$_tasks[self::TASK_DELETE]['title'];
 157       }
 158     }
 159
 160     $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params);
 161     return $tasks;
 162   }
 163
 164   /**
 165    * These tasks are the core set of tasks that the user can perform
 166    * on members
 167    *
 168    * @param int $value
 169    *
 170    * @return array
 171    *   the set of tasks for a group of members
 172    */
 173   public static function getTask($value) {
 174     self::tasks();
 175     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 176       // Make the print task the default
 177       $value = self::TASK_PRINT;
 178     }
 179     return parent::getTask($value);
 180   }
 181
 182 }