3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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 +--------------------------------------------------------------------+
29 * This class stores logic for managing CiviCRM extensions.
32 * @copyright CiviCRM LLC (c) 2004-2018
34 class CRM_Extension_Manager_Search
extends CRM_Extension_Manager_Base
{
36 const CUSTOM_SEARCH_GROUP_NAME
= 'custom_search';
39 * CRM_Extension_Manager_Search constructor.
41 public function __construct() {
42 parent
::__construct(TRUE);
43 $this->groupId
= CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
44 self
::CUSTOM_SEARCH_GROUP_NAME
, 'id', 'name'
49 * @param CRM_Extension_Info $info
54 public function onPreInstall(CRM_Extension_Info
$info) {
55 $customSearchesByName = $this->getCustomSearchesByName();
56 if (array_key_exists($info->key
, $customSearchesByName)) {
57 CRM_Core_Error
::fatal('This custom search is already registered.');
60 $weight = CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
61 array('option_group_id' => $this->groupId
)
65 'option_group_id' => $this->groupId
,
67 'description' => $info->label
. ' (' . $info->key
. ')',
69 'value' => max($customSearchesByName) +
1,
70 'label' => $info->key
,
75 $optionValue = CRM_Core_BAO_OptionValue
::add($params, $ids);
77 return $optionValue ?
TRUE : FALSE;
81 * @param CRM_Extension_Info $info
86 public function onPreUninstall(CRM_Extension_Info
$info) {
87 $customSearchesByName = $this->getCustomSearchesByName();
88 if (!array_key_exists($info->key
, $customSearchesByName)) {
89 CRM_Core_Error
::fatal('This custom search is not registered.');
92 $cs = $this->getCustomSearchesById();
93 $id = $cs[$customSearchesByName[$info->key
]];
94 $optionValue = CRM_Core_BAO_OptionValue
::del($id);
100 * @param CRM_Extension_Info $info
102 public function onPreDisable(CRM_Extension_Info
$info) {
103 $customSearchesByName = $this->getCustomSearchesByName();
104 $cs = $this->getCustomSearchesById();
105 $id = $cs[$customSearchesByName[$info->key
]];
106 $optionValue = CRM_Core_BAO_OptionValue
::setIsActive($id, 0);
110 * @param CRM_Extension_Info $info
112 public function onPreEnable(CRM_Extension_Info
$info) {
113 $customSearchesByName = $this->getCustomSearchesByName();
114 $cs = $this->getCustomSearchesById();
115 $id = $cs[$customSearchesByName[$info->key
]];
116 $optionValue = CRM_Core_BAO_OptionValue
::setIsActive($id, 1);
122 protected function getCustomSearchesByName() {
123 return CRM_Core_OptionGroup
::values(self
::CUSTOM_SEARCH_GROUP_NAME
, TRUE, FALSE, FALSE, NULL, 'name', FALSE, TRUE);
129 protected function getCustomSearchesById() {
130 return CRM_Core_OptionGroup
::values(self
::CUSTOM_SEARCH_GROUP_NAME
, FALSE, FALSE, FALSE, NULL, 'id', FALSE, TRUE);