3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
33 class CRM_Core_OptionValue
{
36 * Static field for all the option value information that we can potentially export.
40 static $_exportableFields = NULL;
43 * Static field for all the option value information that we can potentially export.
47 static $_importableFields = NULL;
50 * Static field for all the option value information that we can potentially export.
54 static $_fields = NULL;
57 * Return option-values of a particular group
59 * @param array $groupParams
60 * Array containing group fields whose option-values is to retrieved.
62 * Has links like edit, delete, disable ..etc.
63 * @param string $orderBy
65 * @param bool $skipEmptyComponents
66 * Whether to skip OptionValue rows with empty Component name
67 * (i.e. when Extension providing the Component is disabled)
70 * Array of option-values
73 public static function getRows($groupParams, $links, $orderBy = 'weight', $skipEmptyComponents = TRUE) {
74 $optionValue = array();
76 $optionGroupID = NULL;
77 if (!isset($groupParams['id']) ||
!$groupParams['id']) {
78 if ($groupParams['name']) {
79 $config = CRM_Core_Config
::singleton();
81 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $dnc);
82 $optionGroupID = $optionGroup->id
;
86 $optionGroupID = $groupParams['id'];
89 $groupName = CRM_Utils_Array
::value('name', $groupParams);
90 if (!$groupName && $optionGroupID) {
91 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
92 $optionGroupID, 'name', 'id'
96 $dao = new CRM_Core_DAO_OptionValue();
99 $dao->option_group_id
= $optionGroupID;
101 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
102 $dao->domain_id
= CRM_Core_Config
::domainID();
105 $dao->orderBy($orderBy);
109 if ($groupName == 'case_type') {
110 $caseTypeIds = CRM_Case_BAO_Case
::getUsedCaseType();
112 elseif ($groupName == 'case_status') {
113 $caseStatusIds = CRM_Case_BAO_Case
::getUsedCaseStatuses();
116 $componentNames = CRM_Core_Component
::getNames();
117 $visibilityLabels = CRM_Core_PseudoConstant
::visibility();
118 while ($dao->fetch()) {
119 $optionValue[$dao->id
] = array();
120 CRM_Core_DAO
::storeValues($dao, $optionValue[$dao->id
]);
121 if (!empty($optionValue[$dao->id
]['component_id']) &&
122 empty($componentNames[$optionValue[$dao->id
]['component_id']]) &&
125 unset($optionValue[$dao->id
]);
128 // form all action links
129 $action = array_sum(array_keys($links));
131 // update enable/disable links depending on if it is is_reserved or is_active
132 if ($dao->is_reserved
) {
133 $action = CRM_Core_Action
::UPDATE
;
136 if ($dao->is_active
) {
137 $action -= CRM_Core_Action
::ENABLE
;
140 $action -= CRM_Core_Action
::DISABLE
;
142 if ((($groupName == 'case_type') && in_array($dao->value
, $caseTypeIds)) ||
143 (($groupName == 'case_status') && in_array($dao->value
, $caseStatusIds))
145 $action -= CRM_Core_Action
::DELETE
;
149 $optionValue[$dao->id
]['label'] = htmlspecialchars($optionValue[$dao->id
]['label']);
150 $optionValue[$dao->id
]['order'] = $optionValue[$dao->id
]['weight'];
151 $optionValue[$dao->id
]['action'] = CRM_Core_Action
::formLink($links, $action,
154 'gid' => $optionGroupID,
155 'value' => $dao->value
,
159 'optionValue.row.actions',
164 if (!empty($optionValue[$dao->id
]['component_id'])) {
165 $optionValue[$dao->id
]['component_name'] = $componentNames[$optionValue[$dao->id
]['component_id']];
168 $optionValue[$dao->id
]['component_name'] = 'Contact';
171 if (!empty($optionValue[$dao->id
]['visibility_id'])) {
172 $optionValue[$dao->id
]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id
]['visibility_id']];
180 * Add/edit option-value of a particular group
182 * @param array $params
183 * Array containing exported values from the invoking form.
184 * @param array $groupParams
185 * Array containing group fields whose option-values is to retrieved/saved.
187 * @param int $optionValueID Has the id of the optionValue being edited, disabled ..etc.
188 * Has the id of the optionValue being edited, disabled ..etc.
190 * @return CRM_Core_DAO_OptionValue
193 public static function addOptionValue(&$params, &$groupParams, &$action, &$optionValueID) {
195 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
196 // checking if the group name with the given id or name (in $groupParams) exists
197 if (!empty($groupParams)) {
198 $config = CRM_Core_Config
::singleton();
199 $groupParams['is_active'] = 1;
200 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $defaults);
203 // if the corresponding group doesn't exist, create one, provided $groupParams has 'name' in it.
204 if (!$optionGroup->id
) {
205 if ($groupParams['name']) {
206 $newOptionGroup = CRM_Core_BAO_OptionGroup
::add($groupParams, $defaults);
207 $params['weight'] = 1;
208 $optionGroupID = $newOptionGroup->id
;
212 $optionGroupID = $optionGroup->id
;
214 if ($optionValueID) {
215 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'weight', 'id');
217 $fieldValues = array('option_group_id' => $optionGroupID);
218 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array
::value('weight', $params), $fieldValues);
220 $params['option_group_id'] = $optionGroupID;
222 if (($action & CRM_Core_Action
::ADD
) && empty($params['value'])) {
223 $fieldValues = array('option_group_id' => $optionGroupID);
224 // use the next available value
225 /* CONVERT(value, DECIMAL) is used to convert varchar
226 field 'value' to decimal->integer */
228 $params['value'] = (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
230 'CONVERT(value, DECIMAL)'
233 if (!$params['label'] && $params['name']) {
234 $params['label'] = $params['name'];
237 // set name to label if it's not set - but *only* for ADD action (CRM-3522)
238 if (($action & CRM_Core_Action
::ADD
) && empty($params['name']) && $params['label']) {
239 $params['name'] = $params['label'];
241 if ($action & CRM_Core_Action
::UPDATE
) {
242 $ids['optionValue'] = $optionValueID;
244 $optionValue = CRM_Core_BAO_OptionValue
::add($params, $ids);
249 * Check if there is a record with the same name in the db.
251 * @param string $value
252 * The value of the field we are checking.
253 * @param string $daoName
254 * The dao object name.
255 * @param string $daoID
256 * The id of the object being updated. u can change your name.
257 * as long as there is no conflict
258 * @param int $optionGroupID
259 * @param string $fieldName
260 * The name of the field in the DAO.
263 * true if object exists
265 public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
266 $object = new $daoName();
267 $object->$fieldName = $value;
268 $object->option_group_id
= $optionGroupID;
270 if ($object->find(TRUE)) {
271 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
279 * Check if there is a record with the same name in the db.
281 * @param string $mode
282 * @param string $contactType
285 * true if object exists
287 public static function getFields($mode = '', $contactType = 'Individual') {
288 $key = "$mode $contactType";
289 if (empty(self
::$_fields[$key]) ||
!self
::$_fields[$key]) {
290 self
::$_fields[$key] = array();
292 $option = CRM_Core_DAO_OptionValue
::import();
294 foreach (array_keys($option) as $id) {
295 $optionName = $option[$id];
298 $nameTitle = array();
299 if ($mode == 'contribute') {
301 'payment_instrument' => array(
302 'name' => 'payment_instrument',
303 'title' => ts('Payment Method'),
304 'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
308 elseif ($mode == '') {
309 //the fields email greeting and postal greeting are meant only for Individual and Household
310 //the field addressee is meant for all contact types, CRM-4575
311 if (in_array($contactType, array(
318 'addressee' => array(
319 'name' => 'addressee',
320 'title' => ts('Addressee'),
321 'headerPattern' => '/^addressee$/i',
325 'email_greeting' => array(
326 'name' => 'email_greeting',
327 'title' => ts('Email Greeting'),
328 'headerPattern' => '/^email_greeting$/i',
330 'postal_greeting' => array(
331 'name' => 'postal_greeting',
332 'title' => ts('Postal Greeting'),
333 'headerPattern' => '/^postal_greeting$/i',
336 $nameTitle = array_merge($nameTitle, $title);
340 if (is_array($nameTitle)) {
341 foreach ($nameTitle as $name => $attribs) {
342 self
::$_fields[$key][$name] = $optionName;
343 list($tableName, $fieldName) = explode('.', $optionName['where']);
344 self
::$_fields[$key][$name]['where'] = "{$name}.label";
345 foreach ($attribs as $k => $val) {
346 self
::$_fields[$key][$name][$k] = $val;
352 return self
::$_fields[$key];
356 * Build select query in case of option-values
360 public static function select(&$query) {
361 if (!empty($query->_params
) ||
!empty($query->_returnProperties
)) {
362 $field = self
::getFields();
363 foreach ($field as $name => $values) {
364 if (!empty($values['pseudoconstant'])) {
367 list($tableName, $fieldName) = explode('.', $values['where']);
368 if (!empty($query->_returnProperties
[$name])) {
369 $query->_select
["{$name}_id"] = "{$name}.value as {$name}_id";
370 $query->_element
["{$name}_id"] = 1;
371 $query->_select
[$name] = "{$name}.{$fieldName} as $name";
372 $query->_tables
[$tableName] = 1;
373 $query->_element
[$name] = 1;
380 * Return option-values of a particular group
382 * @param array $groupParams
383 * Array containing group fields.
384 * whose option-values is to retrieved.
385 * @param array $values
386 * (reference) to the array which.
387 * will have the values for the group
388 * @param string $orderBy
389 * For orderBy clause.
391 * @param bool $isActive Do you want only active option values?
394 * Array of option-values
397 public static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) {
398 if (empty($groupParams)) {
403 option_value.id as id,
404 option_value.label as label,
405 option_value.value as value,
406 option_value.name as name,
407 option_value.description as description,
408 option_value.weight as weight,
409 option_value.is_active as is_active,
410 option_value.is_default as is_default";
414 civicrm_option_value as option_value,
415 civicrm_option_group as option_group ";
417 $where = " WHERE option_group.id = option_value.option_group_id ";
420 $where .= " AND option_value.is_active = " . $isActive;
423 $order = " ORDER BY " . $orderBy;
425 $groupId = CRM_Utils_Array
::value('id', $groupParams);
426 $groupName = CRM_Utils_Array
::value('name', $groupParams);
429 $where .= " AND option_group.id = %1";
430 $params[1] = array($groupId, 'Integer');
432 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
433 $groupId, 'name', 'id'
439 $where .= " AND option_group.name = %2";
440 $params[2] = array($groupName, 'String');
443 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
444 $where .= " AND option_value.domain_id = " . CRM_Core_Config
::domainID();
447 $query = $select . $from . $where . $order;
449 $dao = CRM_Core_DAO
::executeQuery($query, $params);
451 while ($dao->fetch()) {
452 $values[$dao->id
] = array(
454 'label' => $dao->label
,
455 'value' => $dao->value
,
456 'name' => $dao->name
,
457 'description' => $dao->description
,
458 'weight' => $dao->weight
,
459 'is_active' => $dao->is_active
,
460 'is_default' => $dao->is_default
,