CRM/Mailing/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  */
  33
  34 /**
  35  * class to represent the actions that can be performed on a group of contacts
  36  * used by the search forms.
  37  *
  38  */
  39 class CRM_Mailing_Task extends CRM_Core_Task {
  40
  41   static $objectType = 'mailing';
  42
  43   /**
  44    * These tasks are the core set of tasks that the user can perform
  45    * on a contact / group of contacts.
  46    *
  47    * @return array
  48    *   the set of tasks for a group of contacts.
  49    */
  50   public static function tasks() {
  51     if (!(self::$_tasks)) {
  52       self::$_tasks = array(
  53         self::TASK_PRINT => array(
  54           'title' => ts('Print Mailing Recipients'),
  55           'class' => 'CRM_Mailing_Form_Task_Print',
  56           'result' => FALSE,
  57         ),
  58       );
  59
  60       parent::tasks();
  61     }
  62
  63     return self::$_tasks;
  64   }
  65
  66   /**
  67    * Show tasks selectively based on the permission level
  68    * of the user.
  69    *
  70    * @param int $permission
  71    * @param array $params
  72    *
  73    * @return array
  74    *   set of tasks that are valid for the user
  75    */
  76   public static function permissionedTaskTitles($permission, $params = array()) {
  77     $tasks = array();
  78
  79     $tasks = parent::corePermissionedTaskTitles($tasks, $permission, $params);
  80     return $tasks;
  81   }
  82
  83   /**
  84    * These tasks are the core set of tasks that the user can perform.
  85    * on mailing recipients.
  86    *
  87    * @param int $value
  88    *
  89    * @return array
  90    *   the set of tasks for a group of mailing recipients
  91    */
  92   public static function getTask($value) {
  93     self::tasks();
  94     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
  95       // make the print task by default
  96       $value = self::TASK_PRINT;
  97     }
  98
  99     return array(
 100       self::$_tasks[$value]['class'],
 101       self::$_tasks[$value]['result'],
 102     );
 103   }
 104
 105 }