CRM/Mailing/Info.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  * This class introduces component to the system and provides all the
  30  * information about it. It needs to extend CRM_Core_Component_Info
  31  * abstract class.
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2013
  35  * $Id$
  36  *
  37  */
  38 class CRM_Mailing_Info extends CRM_Core_Component_Info {
  39
  40   // docs inherited from interface
  41   protected $keyword = 'mailing';
  42
  43
  44   // docs inherited from interface
  45   public function getInfo() {
  46     return array(
  47       'name' => 'CiviMail',
  48       'translatedName' => ts('CiviMail'),
  49       'title' => 'CiviCRM Mailing Engine',
  50       'search' => 1,
  51       'showActivitiesInCore' => 1,
  52     );
  53   }
  54
  55   static function workflowEnabled() {
  56     $config = CRM_Core_Config::singleton();
  57
  58     // early exit, since not true for most
  59     if (!$config->userSystem->is_drupal ||
  60       !function_exists('module_exists')
  61     ) {
  62       return FALSE;
  63     }
  64
  65     if (!module_exists('rules')) {
  66       return FALSE;
  67     }
  68
  69     $enableWorkflow = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME,
  70       'civimail_workflow',
  71       NULL,
  72       FALSE
  73     );
  74
  75     return ($enableWorkflow &&
  76       $config->userSystem->is_drupal
  77     ) ? TRUE : FALSE;
  78   }
  79
  80   // docs inherited from interface
  81   public function getPermissions($getAllUnconditionally = FALSE) {
  82     $permissions = array(
  83       'access CiviMail',
  84       'access CiviMail subscribe/unsubscribe pages',
  85       'delete in CiviMail',
  86       'view public CiviMail content',
  87     );
  88
  89     if (self::workflowEnabled() || $getAllUnconditionally) {
  90       $permissions[] = 'create mailings';
  91       $permissions[] = 'schedule mailings';
  92       $permissions[] = 'approve mailings';
  93     }
  94
  95     return $permissions;
  96   }
  97
  98
  99   // docs inherited from interface
 100   public function getUserDashboardElement() {
 101     // no dashboard element for this component
 102     return NULL;
 103   }
 104
 105   public function getUserDashboardObject() {
 106     // no dashboard element for this component
 107     return NULL;
 108   }
 109
 110   // docs inherited from interface
 111   public function registerTab() {
 112     return array(
 113       'title' => ts('Mailings'),
 114       'id' => 'mailing',
 115       'url' => 'mailing',
 116       'weight' => 45,
 117     );
 118   }
 119
 120   // docs inherited from interface
 121   public function registerAdvancedSearchPane() {
 122     return array('title' => ts('Mailings'),
 123       'weight' => 20,
 124     );
 125   }
 126
 127   // docs inherited from interface
 128   public function getActivityTypes() {
 129     return NULL;
 130   }
 131
 132   // add shortcut to Create New
 133   public function creatNewShortcut(&$shortCuts) {}
 134 }
 135