CRM/Report/Page/Options.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2014
  33  * $Id$
  34  *
  35  */
  36
  37 /**
  38  * Page for displaying list of Gender
  39  */
  40 class CRM_Report_Page_Options extends CRM_Core_Page_Basic {
  41
  42   public $useLivePageJS = TRUE;
  43
  44   /**
  45    * The action links that we need to display for the browse screen
  46    *
  47    * @var array
  48    * @static
  49    */
  50   static $_links = NULL;
  51
  52   /**
  53    * The option group name
  54    *
  55    * @var array
  56    * @static
  57    */
  58   static $_gName = NULL;
  59
  60   /**
  61    * The option group name in display format (capitalized, without underscores...etc)
  62    *
  63    * @var array
  64    * @static
  65    */
  66   static $_GName = NULL;
  67
  68   /**
  69    * The option group id
  70    *
  71    * @var array
  72    * @static
  73    */
  74   static $_gId = NULL;
  75
  76   /**
  77    * Obtains the group name from url and sets the title.
  78    *
  79    * @return void
  80    *
  81    */
  82   public function preProcess() {
  83     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE);
  84     $this->_id = CRM_Utils_Request::retrieve('id', 'String', $this, FALSE);
  85
  86     self::$_gName = "report_template";
  87
  88     if (self::$_gName) {
  89       self::$_gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gName, 'id', 'name');
  90     }
  91     else {
  92       CRM_Core_Error::fatal();
  93     }
  94
  95     self::$_GName = ucwords(str_replace('_', ' ', self::$_gName));
  96
  97     $this->assign('GName', self::$_GName);
  98     $newReportURL = CRM_Utils_System::url("civicrm/admin/report/register",
  99       'reset=1'
 100     );
 101     $this->assign('newReport', $newReportURL);
 102     CRM_Utils_System::setTitle(ts('Registered Templates'));
 103   }
 104
 105   /**
 106    * Get BAO Name
 107    *
 108    * @return string Classname of BAO.
 109    */
 110   public function getBAOName() {
 111     return 'CRM_Core_BAO_OptionValue';
 112   }
 113
 114   /**
 115    * Get action Links
 116    *
 117    * @return array (reference) of action links
 118    */
 119   public function &links() {
 120     if (!(self::$_links)) {
 121       self::$_links = array(
 122         CRM_Core_Action::UPDATE => array(
 123           'name' => ts('Edit'),
 124           'url' => 'civicrm/admin/report/register/' . self::$_gName,
 125           'qs' => 'action=update&id=%%id%%&reset=1',
 126           'title' => ts('Edit %1', array(1 => self::$_gName)),
 127         ),
 128         CRM_Core_Action::DISABLE => array(
 129           'name' => ts('Disable'),
 130           'ref' => 'crm-enable-disable',
 131           'title' => ts('Disable %1', array(1 => self::$_gName)),
 132         ),
 133         CRM_Core_Action::ENABLE => array(
 134           'name' => ts('Enable'),
 135           'ref' => 'crm-enable-disable',
 136           'title' => ts('Enable %1', array(1 => self::$_gName)),
 137         ),
 138         CRM_Core_Action::DELETE => array(
 139           'name' => ts('Delete'),
 140           'url' => 'civicrm/admin/report/register/' . self::$_gName,
 141           'qs' => 'action=delete&id=%%id%%&reset=1',
 142           'title' => ts('Delete %1 Type', array(1 => self::$_gName)),
 143         ),
 144       );
 145     }
 146
 147     return self::$_links;
 148   }
 149
 150   /**
 151    * Run the basic page (run essentially starts execution for that page).
 152    *
 153    * @return void
 154    */
 155   public function run() {
 156     $this->preProcess();
 157     return parent::run();
 158   }
 159
 160   /**
 161    * Browse all options
 162    *
 163    *
 164    * @return void
 165    * @static
 166    */
 167   public function browse() {
 168     $groupParams = array('name' => self::$_gName);
 169     $optionValue = CRM_Core_OptionValue::getRows($groupParams, $this->links(), 'weight');
 170     $gName       = self::$_gName;
 171     $returnURL   = CRM_Utils_System::url("civicrm/admin/report/options/$gName",
 172       "reset=1"
 173     );
 174     $filter = "option_group_id = " . self::$_gId;
 175
 176     $session = new CRM_Core_Session();
 177     $session->replaceUserContext($returnURL);
 178     CRM_Utils_Weight::addOrder($optionValue, 'CRM_Core_DAO_OptionValue',
 179       'id', $returnURL, $filter
 180     );
 181     $this->assign('rows', $optionValue);
 182   }
 183
 184   /**
 185    * Get name of edit form
 186    *
 187    * @return string Classname of edit form.
 188    */
 189   public function editForm() {
 190     return 'CRM_Report_Form_Register';
 191   }
 192
 193   /**
 194    * Get edit form name
 195    *
 196    * @return string name of this page.
 197    */
 198   public function editName() {
 199     return self::$_GName;
 200   }
 201
 202   /**
 203    * Get user context.
 204    *
 205    * @param null $mode
 206    *
 207    * @return string user context.
 208    */
 209   public function userContext($mode = NULL) {
 210     return 'civicrm/report/options/' . self::$_gName;
 211   }
 212
 213   /**
 214    * Get userContext params
 215    *
 216    * @param int $mode
 217    *   Mode that we are in.
 218    *
 219    * @return string
 220    */
 221   public function userContextParams($mode = NULL) {
 222     return 'reset=1&action=browse';
 223   }
 224 }