CRM/Admin/Page/Options.php

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