CRM/Mailing/Page/Component.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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  * Page to display / edit the header / footer of a mailing
  38  *
  39  */
  40 class CRM_Mailing_Page_Component extends CRM_Core_Page_Basic {
  41
  42   /**
  43    * The action links that we need to display for the browse screen
  44    *
  45    * @var array
  46    */
  47   static $_links = NULL;
  48
  49   /**
  50    * Get BAO Name
  51    *
  52    * @return string
  53    *   Classname of BAO.
  54    */
  55   public function getBAOName() {
  56     return 'CRM_Mailing_BAO_Component';
  57   }
  58
  59   /**
  60    * Get action Links
  61    *
  62    * @return array
  63    *   (reference) of action links
  64    */
  65   public function &links() {
  66     if (!(self::$_links)) {
  67       self::$_links = array(
  68         CRM_Core_Action::UPDATE => array(
  69           'name' => ts('Edit'),
  70           'url' => CRM_Utils_System::currentPath(),
  71           'qs' => 'action=update&id=%%id%%',
  72           'title' => ts('Edit Mailing Component'),
  73         ),
  74         CRM_Core_Action::DISABLE => array(
  75           'name' => ts('Disable'),
  76           'ref' => 'crm-enable-disable',
  77           'title' => ts('Disable Mailing Component'),
  78         ),
  79         CRM_Core_Action::ENABLE => array(
  80           'name' => ts('Enable'),
  81           'ref' => 'crm-enable-disable',
  82           'title' => ts('Enable Mailing Component'),
  83         ),
  84       );
  85     }
  86     return self::$_links;
  87   }
  88
  89   /**
  90    * Get name of edit form
  91    *
  92    * @return string
  93    *   Classname of edit form.
  94    */
  95   public function editForm() {
  96     return 'CRM_Mailing_Form_Component';
  97   }
  98
  99   /**
 100    * Get edit form name
 101    *
 102    * @return string
 103    *   name of this page.
 104    */
 105   public function editName() {
 106     return 'Mailing Components';
 107   }
 108
 109   /**
 110    * Get user context.
 111    *
 112    * @param null $mode
 113    *
 114    * @return string
 115    *   user context.
 116    */
 117   public function userContext($mode = NULL) {
 118     return CRM_Utils_System::currentPath();
 119   }
 120
 121   /**
 122    * @param null $args
 123    * @param null $pageArgs
 124    * @param null $sort
 125    */
 126   public function run($args = NULL, $pageArgs = NULL, $sort = NULL) {
 127     return parent::run($args, $pageArgs, "component_type, is_default desc, name");
 128   }
 129 }