3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
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
67 * Array of option-values
70 public static function getRows($groupParams, $links, $orderBy = 'weight') {
71 $optionValue = array();
73 $optionGroupID = NULL;
74 if (!isset($groupParams['id']) ||
!$groupParams['id']) {
75 if ($groupParams['name']) {
76 $config = CRM_Core_Config
::singleton();
78 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $dnc);
79 $optionGroupID = $optionGroup->id
;
83 $optionGroupID = $groupParams['id'];
86 $groupName = CRM_Utils_Array
::value('name', $groupParams);
87 if (!$groupName && $optionGroupID) {
88 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
89 $optionGroupID, 'name', 'id'
93 $dao = new CRM_Core_DAO_OptionValue();
96 $dao->option_group_id
= $optionGroupID;
98 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
99 $dao->domain_id
= CRM_Core_Config
::domainID();
102 $dao->orderBy($orderBy);
106 if ($groupName == 'case_type') {
107 $caseTypeIds = CRM_Case_BAO_Case
::getUsedCaseType();
109 elseif ($groupName == 'case_status') {
110 $caseStatusIds = CRM_Case_BAO_Case
::getUsedCaseStatuses();
113 $componentNames = CRM_Core_Component
::getNames();
114 $visibilityLabels = CRM_Core_PseudoConstant
::visibility();
115 while ($dao->fetch()) {
116 $optionValue[$dao->id
] = array();
117 CRM_Core_DAO
::storeValues($dao, $optionValue[$dao->id
]);
118 // form all action links
119 $action = array_sum(array_keys($links));
121 // update enable/disable links depending on if it is is_reserved or is_active
122 if ($dao->is_reserved
) {
123 $action = CRM_Core_Action
::UPDATE
;
126 if ($dao->is_active
) {
127 $action -= CRM_Core_Action
::ENABLE
;
130 $action -= CRM_Core_Action
::DISABLE
;
132 if ((($groupName == 'case_type') && in_array($dao->value
, $caseTypeIds)) ||
133 (($groupName == 'case_status') && in_array($dao->value
, $caseStatusIds))
135 $action -= CRM_Core_Action
::DELETE
;
139 $optionValue[$dao->id
]['label'] = htmlspecialchars($optionValue[$dao->id
]['label']);
140 $optionValue[$dao->id
]['order'] = $optionValue[$dao->id
]['weight'];
141 $optionValue[$dao->id
]['action'] = CRM_Core_Action
::formLink($links, $action,
144 'gid' => $optionGroupID,
145 'value' => $dao->value
,
149 'optionValue.row.actions',
154 if (!empty($optionValue[$dao->id
]['component_id'])) {
155 $optionValue[$dao->id
]['component_name'] = $componentNames[$optionValue[$dao->id
]['component_id']];
158 $optionValue[$dao->id
]['component_name'] = 'Contact';
161 if (!empty($optionValue[$dao->id
]['visibility_id'])) {
162 $optionValue[$dao->id
]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id
]['visibility_id']];
170 * Add/edit option-value of a particular group
172 * @param array $params
173 * Array containing exported values from the invoking form.
174 * @param array $groupParams
175 * Array containing group fields whose option-values is to retrieved/saved.
177 * @param int $optionValueID Has the id of the optionValue being edited, disabled ..etc.
178 * Has the id of the optionValue being edited, disabled ..etc.
180 * @return CRM_Core_DAO_OptionValue
183 public static function addOptionValue(&$params, &$groupParams, &$action, &$optionValueID) {
184 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
185 // checking if the group name with the given id or name (in $groupParams) exists
186 if (!empty($groupParams)) {
187 $config = CRM_Core_Config
::singleton();
188 $groupParams['is_active'] = 1;
189 $optionGroup = CRM_Core_BAO_OptionGroup
::retrieve($groupParams, $defaults);
192 // if the corresponding group doesn't exist, create one, provided $groupParams has 'name' in it.
193 if (!$optionGroup->id
) {
194 if ($groupParams['name']) {
195 $newOptionGroup = CRM_Core_BAO_OptionGroup
::add($groupParams, $defaults);
196 $params['weight'] = 1;
197 $optionGroupID = $newOptionGroup->id
;
201 $optionGroupID = $optionGroup->id
;
203 if ($optionValueID) {
204 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'weight', 'id');
206 $fieldValues = array('option_group_id' => $optionGroupID);
207 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array
::value('weight', $params), $fieldValues);
209 $params['option_group_id'] = $optionGroupID;
211 if (($action & CRM_Core_Action
::ADD
) && empty($params['value'])) {
212 $fieldValues = array('option_group_id' => $optionGroupID);
213 // use the next available value
214 /* CONVERT(value, DECIMAL) is used to convert varchar
215 field 'value' to decimal->integer */
217 $params['value'] = (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
219 'CONVERT(value, DECIMAL)'
222 if (!$params['label'] && $params['name']) {
223 $params['label'] = $params['name'];
226 // set name to label if it's not set - but *only* for ADD action (CRM-3522)
227 if (($action & CRM_Core_Action
::ADD
) && empty($params['name']) && $params['label']) {
228 $params['name'] = $params['label'];
230 if ($action & CRM_Core_Action
::UPDATE
) {
231 $ids['optionValue'] = $optionValueID;
233 $optionValue = CRM_Core_BAO_OptionValue
::add($params, $ids);
238 * Check if there is a record with the same name in the db.
240 * @param string $value
241 * The value of the field we are checking.
242 * @param string $daoName
243 * The dao object name.
244 * @param string $daoID
245 * The id of the object being updated. u can change your name.
246 * as long as there is no conflict
247 * @param int $optionGroupID
248 * @param string $fieldName
249 * The name of the field in the DAO.
252 * true if object exists
254 public static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
255 $object = new $daoName();
256 $object->$fieldName = $value;
257 $object->option_group_id
= $optionGroupID;
259 if ($object->find(TRUE)) {
260 return ($daoID && $object->id
== $daoID) ?
TRUE : FALSE;
268 * Check if there is a record with the same name in the db.
270 * @param string $mode
271 * @param string $contactType
274 * true if object exists
276 public static function getFields($mode = '', $contactType = 'Individual') {
277 $key = "$mode $contactType";
278 if (empty(self
::$_fields[$key]) ||
!self
::$_fields[$key]) {
279 self
::$_fields[$key] = array();
281 $option = CRM_Core_DAO_OptionValue
::import();
283 foreach (array_keys($option) as $id) {
284 $optionName = $option[$id];
287 $nameTitle = array();
288 if ($mode == 'contribute') {
290 'payment_instrument' => array(
291 'name' => 'payment_instrument',
292 'title' => ts('Payment Method'),
293 'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
297 elseif ($mode == '') {
298 //the fields email greeting and postal greeting are meant only for Individual and Household
299 //the field addressee is meant for all contact types, CRM-4575
300 if (in_array($contactType, array(
307 'addressee' => array(
308 'name' => 'addressee',
309 'title' => ts('Addressee'),
310 'headerPattern' => '/^addressee$/i',
314 'email_greeting' => array(
315 'name' => 'email_greeting',
316 'title' => ts('Email Greeting'),
317 'headerPattern' => '/^email_greeting$/i',
319 'postal_greeting' => array(
320 'name' => 'postal_greeting',
321 'title' => ts('Postal Greeting'),
322 'headerPattern' => '/^postal_greeting$/i',
325 $nameTitle = array_merge($nameTitle, $title);
329 if (is_array($nameTitle)) {
330 foreach ($nameTitle as $name => $attribs) {
331 self
::$_fields[$key][$name] = $optionName;
332 list($tableName, $fieldName) = explode('.', $optionName['where']);
333 self
::$_fields[$key][$name]['where'] = "{$name}.label";
334 foreach ($attribs as $k => $val) {
335 self
::$_fields[$key][$name][$k] = $val;
341 return self
::$_fields[$key];
345 * Build select query in case of option-values
349 public static function select(&$query) {
350 if (!empty($query->_params
) ||
!empty($query->_returnProperties
)) {
351 $field = self
::getFields();
352 foreach ($field as $name => $values) {
353 if (!empty($values['pseudoconstant'])) {
356 list($tableName, $fieldName) = explode('.', $values['where']);
357 if (!empty($query->_returnProperties
[$name])) {
358 $query->_select
["{$name}_id"] = "{$name}.value as {$name}_id";
359 $query->_element
["{$name}_id"] = 1;
360 $query->_select
[$name] = "{$name}.{$fieldName} as $name";
361 $query->_tables
[$tableName] = 1;
362 $query->_element
[$name] = 1;
369 * Return option-values of a particular group
371 * @param array $groupParams
372 * Array containing group fields.
373 * whose option-values is to retrieved.
374 * @param array $values
375 * (reference) to the array which.
376 * will have the values for the group
377 * @param string $orderBy
378 * For orderBy clause.
380 * @param bool $isActive Do you want only active option values?
383 * Array of option-values
386 public static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) {
387 if (empty($groupParams)) {
392 option_value.id as id,
393 option_value.label as label,
394 option_value.value as value,
395 option_value.name as name,
396 option_value.description as description,
397 option_value.weight as weight,
398 option_value.is_active as is_active,
399 option_value.is_default as is_default";
403 civicrm_option_value as option_value,
404 civicrm_option_group as option_group ";
406 $where = " WHERE option_group.id = option_value.option_group_id ";
409 $where .= " AND option_value.is_active = " . $isActive;
412 $order = " ORDER BY " . $orderBy;
414 $groupId = CRM_Utils_Array
::value('id', $groupParams);
415 $groupName = CRM_Utils_Array
::value('name', $groupParams);
418 $where .= " AND option_group.id = %1";
419 $params[1] = array($groupId, 'Integer');
421 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
422 $groupId, 'name', 'id'
428 $where .= " AND option_group.name = %2";
429 $params[2] = array($groupName, 'String');
432 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
433 $where .= " AND option_value.domain_id = " . CRM_Core_Config
::domainID();
436 $query = $select . $from . $where . $order;
438 $dao = CRM_Core_DAO
::executeQuery($query, $params);
440 while ($dao->fetch()) {
441 $values[$dao->id
] = array(
443 'label' => $dao->label
,
444 'value' => $dao->value
,
445 'name' => $dao->name
,
446 'description' => $dao->description
,
447 'weight' => $dao->weight
,
448 'is_active' => $dao->is_active
,
449 'is_default' => $dao->is_default
,