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