CRM/Mailing/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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('title' => ts('Print Mailing Recipients'),
  70           'class' => 'CRM_Mailing_Form_Task_Print',
  71           'result' => FALSE,
  72         ),
  73       );
  74
  75       CRM_Utils_Hook::searchTasks('mailing', self::$_tasks);
  76       asort(self::$_tasks);
  77     }
  78
  79     return self::$_tasks;
  80   }
  81
  82   /**
  83    * These tasks are the core set of task titles
  84    * on mailing recipients
  85    *
  86    * @return array the set of task titles
  87    * @static
  88    * @access public
  89    */
  90   static function &taskTitles() {
  91     return array();
  92   }
  93
  94   /**
  95    * show tasks selectively based on the permission level
  96    * of the user
  97    *
  98    * @param int $permission
  99    *
 100    * @return array set of tasks that are valid for the user
 101    * @access public
 102    */
 103   static function &permissionedTaskTitles($permission) {
 104     $task = array();
 105     return $task;
 106   }
 107
 108   /**
 109    * These tasks are the core set of tasks that the user can perform
 110    * on mailing recipients
 111    *
 112    * @param int $value
 113    *
 114    * @return array the set of tasks for a group of mailing recipients
 115    * @static
 116    * @access public
 117    */
 118   static function getTask($value) {
 119     self::tasks();
 120     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
 121       // make the print task by default
 122       $value = 1;
 123     }
 124     return array(
 125       self::$_tasks[$value]['class'],
 126       self::$_tasks[$value]['result'],
 127     );
 128   }
 129 }