CRM/Mailing/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   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 {
  40   /**
  41    * The task array.
  42    *
  43    * @var array
  44    */
  45   static $_tasks = NULL;
  46
  47   /**
  48    * The optional task array.
  49    *
  50    * @var array
  51    */
  52   static $_optionalTasks = NULL;
  53
  54   /**
  55    * These tasks are the core set of tasks that the user can perform
  56    * on a contact / group of contacts.
  57    *
  58    * @return array
  59    *   the set of tasks for a group of contacts.
  60    */
  61   public static function &tasks() {
  62     if (!(self::$_tasks)) {
  63       self::$_tasks = array(
  64         1 => array(
  65           'title' => ts('Print Mailing Recipients'),
  66           'class' => 'CRM_Mailing_Form_Task_Print',
  67           'result' => FALSE,
  68         ),
  69       );
  70
  71       CRM_Utils_Hook::searchTasks('mailing', self::$_tasks);
  72       asort(self::$_tasks);
  73     }
  74
  75     return self::$_tasks;
  76   }
  77
  78   /**
  79    * These tasks are the core set of task titles
  80    * on mailing recipients.
  81    *
  82    * @return array
  83    *   the set of task titles.
  84    */
  85   public static function &taskTitles() {
  86     return array();
  87   }
  88
  89   /**
  90    * Show tasks selectively based on the permission level
  91    * of the user.
  92    *
  93    * @param int $permission
  94    *
  95    * @return array
  96    *   set of tasks that are valid for the user
  97    */
  98   public static function &permissionedTaskTitles($permission) {
  99     $task = array();
 100     return $task;
 101   }
 102
 103   /**
 104    * These tasks are the core set of tasks that the user can perform.
 105    * on mailing recipients.
 106    *
 107    * @param int $value
 108    *
 109    * @return array
 110    *   the set of tasks for a group of mailing recipients
 111    */
 112   public static function getTask($value) {
 113     self::tasks();
 114     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 115       // make the print task by default
 116       $value = 1;
 117     }
 118     return array(
 119       self::$_tasks[$value]['class'],
 120       self::$_tasks[$value]['result'],
 121     );
 122   }
 123
 124 }