CRM/Admin/Page/Options.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 for displaying list of Gender
  38  */
  39 class CRM_Admin_Page_Options extends CRM_Core_Page_Basic {
  40
  41   public $useLivePageJS = TRUE;
  42
  43   /**
  44    * The action links that we need to display for the browse screen.
  45    *
  46    * @var array
  47    */
  48   static $_links = NULL;
  49
  50   /**
  51    * The option group name.
  52    *
  53    * @var array
  54    */
  55   static $_gName = NULL;
  56
  57   /**
  58    * The option group name in display format (capitalized, without underscores...etc)
  59    *
  60    * @var array
  61    */
  62   static $_gLabel = NULL;
  63
  64   /**
  65    * The option group id.
  66    *
  67    * @var array
  68    */
  69   static $_gId = NULL;
  70
  71   /**
  72    * A boolean determining if you can add options to this group in the GUI.
  73    *
  74    * @var boolean
  75    */
  76   static $_isLocked = FALSE;
  77
  78   /**
  79    * Obtains the group name from url string or id from $_GET['gid'].
  80    * Sets the title.
  81    *
  82    * @return void
  83    */
  84   public function preProcess() {
  85     if (!self::$_gName && !empty($this->urlPath[3])) {
  86       self::$_gName = $this->urlPath[3];
  87     }
  88     // If an id arg is passed instead of a group name in the path
  89     elseif (!self::$_gName && !empty($_GET['gid'])) {
  90       self::$_gId = $_GET['gid'];
  91       self::$_gName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'name');
  92       self::$_isLocked = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'is_locked');
  93       $breadCrumb = array(
  94         'title' => ts('Option Groups'),
  95         'url' => CRM_Utils_System::url('civicrm/admin/options', 'reset=1'),
  96       );
  97       CRM_Utils_System::appendBreadCrumb(array($breadCrumb));
  98     }
  99     if (!self::$_gName) {
 100       self::$_gName = $this->get('gName');
 101     }
 102     // If we don't have a group we will browse all groups
 103     if (!self::$_gName) {
 104       return;
 105     }
 106     $this->set('gName', self::$_gName);
 107     if (!self::$_gId) {
 108       self::$_gId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gName, 'id', 'name');
 109     }
 110
 111     self::$_gLabel = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', self::$_gId, 'title');
 112     if (!self::$_gLabel) {
 113       self::$_gLabel = ts('Option');
 114     }
 115
 116     $this->assign('gName', self::$_gName);
 117     $this->assign('gLabel', self::$_gLabel);
 118
 119     if (self::$_gName == 'acl_role') {
 120       CRM_Utils_System::setTitle(ts('Manage ACL Roles'));
 121       // set breadcrumb to append to admin/access
 122       $breadCrumb = array(
 123         array(
 124           'title' => ts('Access Control'),
 125           'url' => CRM_Utils_System::url('civicrm/admin/access',
 126             'reset=1'
 127           ),
 128         ),
 129       );
 130       CRM_Utils_System::appendBreadCrumb($breadCrumb);
 131     }
 132     else {
 133       CRM_Utils_System::setTitle(ts("%1 Options", array(1 => self::$_gLabel)));
 134     }
 135     if (in_array(self::$_gName,
 136       array(
 137         'from_email_address',
 138         'email_greeting',
 139         'postal_greeting',
 140         'addressee',
 141         'communication_style',
 142         'case_status',
 143         'encounter_medium',
 144         'case_type',
 145         'payment_instrument',
 146         'soft_credit_type',
 147         'website_type',
 148       )
 149     )) {
 150       $this->assign('showIsDefault', TRUE);
 151     }
 152
 153     if (self::$_gName == 'participant_role') {
 154       $this->assign('showCounted', TRUE);
 155     }
 156     $this->assign('isLocked', self::$_isLocked);
 157     $config = CRM_Core_Config::singleton();
 158     if (self::$_gName == 'activity_type') {
 159       $this->assign('showComponent', TRUE);
 160     }
 161   }
 162
 163   /**
 164    * Get BAO Name.
 165    *
 166    * @return string
 167    *   Classname of BAO.
 168    */
 169   public function getBAOName() {
 170     return self::$_gName ? 'CRM_Core_BAO_OptionValue' : 'CRM_Core_BAO_OptionGroup';
 171   }
 172
 173   /**
 174    * Get action Links.
 175    *
 176    * @return array
 177    *   (reference) of action links
 178    */
 179   public function &links() {
 180     if (!(self::$_links)) {
 181       self::$_links = array(
 182         CRM_Core_Action::UPDATE => array(
 183           'name' => ts('Edit'),
 184           'url' => 'civicrm/admin/options/' . self::$_gName,
 185           'qs' => 'action=update&id=%%id%%&reset=1',
 186           'title' => ts('Edit %1', array(1 => self::$_gName)),
 187         ),
 188         CRM_Core_Action::DISABLE => array(
 189           'name' => ts('Disable'),
 190           'ref' => 'crm-enable-disable',
 191           'title' => ts('Disable %1', array(1 => self::$_gName)),
 192         ),
 193         CRM_Core_Action::ENABLE => array(
 194           'name' => ts('Enable'),
 195           'ref' => 'crm-enable-disable',
 196           'title' => ts('Enable %1', array(1 => self::$_gName)),
 197         ),
 198         CRM_Core_Action::DELETE => array(
 199           'name' => ts('Delete'),
 200           'url' => 'civicrm/admin/options/' . self::$_gName,
 201           'qs' => 'action=delete&id=%%id%%',
 202           'title' => ts('Delete %1 Type', array(1 => self::$_gName)),
 203         ),
 204       );
 205
 206       if (self::$_gName == 'custom_search') {
 207         $runLink = array(
 208           CRM_Core_Action::FOLLOWUP => array(
 209             'name' => ts('Run'),
 210             'url' => 'civicrm/contact/search/custom',
 211             'qs' => 'reset=1&csid=%%value%%',
 212             'title' => ts('Run %1', array(1 => self::$_gName)),
 213           ),
 214         );
 215         self::$_links = $runLink + self::$_links;
 216       }
 217     }
 218     return self::$_links;
 219   }
 220
 221   /**
 222    * Run the basic page (run essentially starts execution for that page).
 223    *
 224    * @return void
 225    */
 226   public function run() {
 227     $this->preProcess();
 228     return parent::run();
 229   }
 230
 231   /**
 232    * Browse all options.
 233    *
 234    *
 235    * @return void
 236    */
 237   public function browse() {
 238     if (!self::$_gName) {
 239       return parent::browse();
 240     }
 241     $groupParams = array('name' => self::$_gName);
 242     $optionValue = CRM_Core_OptionValue::getRows($groupParams, $this->links(), 'component_id,weight');
 243     $gName = self::$_gName;
 244     $returnURL = CRM_Utils_System::url("civicrm/admin/options/$gName",
 245       "reset=1&group=$gName"
 246     );
 247     $filter = "option_group_id = " . self::$_gId;
 248     CRM_Utils_Weight::addOrder($optionValue, 'CRM_Core_DAO_OptionValue',
 249       'id', $returnURL, $filter
 250     );
 251
 252     // retrieve financial account name for the payment instrument page
 253     if ($gName = "payment_instrument") {
 254       foreach ($optionValue as $key => $option) {
 255         $optionValue[$key]['financial_account'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($key, 'civicrm_option_value');
 256       }
 257     }
 258     $this->assign('rows', $optionValue);
 259   }
 260
 261   /**
 262    * Get name of edit form.
 263    *
 264    * @return string
 265    *   Classname of edit form.
 266    */
 267   public function editForm() {
 268     return self::$_gName ? 'CRM_Admin_Form_Options' : 'CRM_Admin_Form_OptionGroup';
 269   }
 270
 271   /**
 272    * Get edit form name.
 273    *
 274    * @return string
 275    *   name of this page.
 276    */
 277   public function editName() {
 278     return self::$_gLabel;
 279   }
 280
 281   /**
 282    * Get user context.
 283    *
 284    * @param null $mode
 285    *
 286    * @return string
 287    *   user context.
 288    */
 289   public function userContext($mode = NULL) {
 290     return 'civicrm/admin/options' . (self::$_gName ? '/' . self::$_gName : '');
 291   }
 292
 293 }