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