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