Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * This class introduces component to the system and provides all the | |
30 | * information about it. It needs to extend CRM_Core_Component_Info | |
31 | * abstract class. | |
32 | * | |
33 | * @package CRM | |
fa938177 | 34 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
35 | */ |
36 | class CRM_Case_Info extends CRM_Core_Component_Info { | |
37 | ||
38 | ||
e7c15cb6 CW |
39 | /** |
40 | * @inheritDoc | |
41 | */ | |
6a488035 TO |
42 | protected $keyword = 'case'; |
43 | ||
4c6ce474 | 44 | /** |
e7c15cb6 | 45 | * @inheritDoc |
4c6ce474 EM |
46 | * @return array |
47 | */ | |
6a488035 TO |
48 | public function getInfo() { |
49 | return array( | |
50 | 'name' => 'CiviCase', | |
51 | 'translatedName' => ts('CiviCase'), | |
52 | 'title' => ts('CiviCase Engine'), | |
53 | 'search' => 1, | |
54 | 'showActivitiesInCore' => 0, | |
55 | ); | |
56 | } | |
57 | ||
4c58e251 | 58 | /** |
e7c15cb6 | 59 | * @inheritDoc |
4c58e251 TO |
60 | */ |
61 | public function getAngularModules() { | |
62 | $result = array(); | |
d08319ae TO |
63 | $result['crmCaseType'] = array( |
64 | 'ext' => 'civicrm', | |
5a173b92 TO |
65 | 'js' => array('ang/crmCaseType.js'), |
66 | 'css' => array('ang/crmCaseType.css'), | |
67 | 'partials' => array('ang/crmCaseType'), | |
d08319ae | 68 | ); |
8c7e0ae8 | 69 | |
dc7a657e TO |
70 | CRM_Core_Resources::singleton()->addSetting(array( |
71 | 'crmCaseType' => array( | |
9625aad1 | 72 | 'REL_TYPE_CNAME' => CRM_Case_XMLProcessor::REL_TYPE_CNAME, |
dc7a657e TO |
73 | ), |
74 | )); | |
4c58e251 TO |
75 | return $result; |
76 | } | |
77 | ||
4c6ce474 | 78 | /** |
e7c15cb6 | 79 | * @inheritDoc |
4c6ce474 EM |
80 | * @return array |
81 | * @throws CRM_Core_Exception | |
82 | */ | |
78650402 | 83 | public function getManagedEntities() { |
32e74b94 TO |
84 | $entities = array_merge( |
85 | CRM_Case_ManagedEntities::createManagedCaseTypes(), | |
86 | CRM_Case_ManagedEntities::createManagedActivityTypes(CRM_Case_XMLRepository::singleton(), CRM_Core_ManagedEntities::singleton()), | |
87 | CRM_Case_ManagedEntities::createManagedRelationshipTypes(CRM_Case_XMLRepository::singleton(), CRM_Core_ManagedEntities::singleton()) | |
88 | ); | |
78650402 N |
89 | return $entities; |
90 | } | |
91 | ||
4c6ce474 | 92 | /** |
e7c15cb6 | 93 | * @inheritDoc |
4c6ce474 | 94 | * @param bool $getAllUnconditionally |
221b21b4 AH |
95 | * @param bool $descriptions |
96 | * Whether to return permission descriptions | |
4c6ce474 EM |
97 | * |
98 | * @return array | |
99 | */ | |
221b21b4 AH |
100 | public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) { |
101 | $permissions = array( | |
102 | 'delete in CiviCase' => array( | |
103 | ts('delete in CiviCase'), | |
174a1918 | 104 | ts('Delete cases'), |
221b21b4 AH |
105 | ), |
106 | 'administer CiviCase' => array( | |
107 | ts('administer CiviCase'), | |
174a1918 | 108 | ts('Define case types, access deleted cases'), |
221b21b4 AH |
109 | ), |
110 | 'access my cases and activities' => array( | |
111 | ts('access my cases and activities'), | |
174a1918 | 112 | ts('View and edit only those cases managed by this user'), |
221b21b4 AH |
113 | ), |
114 | 'access all cases and activities' => array( | |
115 | ts('access all cases and activities'), | |
174a1918 | 116 | ts('View and edit all cases (for visible contacts)'), |
221b21b4 AH |
117 | ), |
118 | 'add cases' => array( | |
119 | ts('add cases'), | |
174a1918 | 120 | ts('Open a new case'), |
221b21b4 | 121 | ), |
6a488035 | 122 | ); |
221b21b4 AH |
123 | |
124 | if (!$descriptions) { | |
125 | foreach ($permissions as $name => $attr) { | |
126 | $permissions[$name] = array_shift($attr); | |
127 | } | |
128 | } | |
129 | ||
130 | return $permissions; | |
6a488035 TO |
131 | } |
132 | ||
168f458e | 133 | /** |
e7c15cb6 | 134 | * @inheritDoc |
168f458e TO |
135 | */ |
136 | public function getReferenceCounts($dao) { | |
137 | $result = array(); | |
138 | if ($dao instanceof CRM_Core_DAO_OptionValue) { | |
139 | /** @var $dao CRM_Core_DAO_OptionValue */ | |
140 | $activity_type_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_type', 'id', 'name'); | |
141 | if ($activity_type_gid == $dao->option_group_id) { | |
142 | $count = CRM_Case_XMLRepository::singleton() | |
143 | ->getActivityReferenceCount($dao->name); | |
144 | if ($count > 0) { | |
145 | $result[] = array( | |
146 | 'name' => 'casetypexml:activities', | |
147 | 'type' => 'casetypexml', | |
148 | 'count' => $count, | |
149 | ); | |
150 | } | |
151 | } | |
152 | } | |
153 | elseif ($dao instanceof CRM_Contact_DAO_RelationshipType) { | |
154 | /** @var $dao CRM_Contact_DAO_RelationshipType */ | |
155 | $count = CRM_Case_XMLRepository::singleton() | |
156 | ->getRelationshipReferenceCount($dao->{CRM_Case_XMLProcessor::REL_TYPE_CNAME}); | |
157 | if ($count > 0) { | |
158 | $result[] = array( | |
159 | 'name' => 'casetypexml:relationships', | |
160 | 'type' => 'casetypexml', | |
161 | 'count' => $count, | |
162 | ); | |
163 | } | |
164 | } | |
165 | return $result; | |
166 | } | |
167 | ||
4c6ce474 | 168 | /** |
e7c15cb6 | 169 | * @inheritDoc |
4c6ce474 EM |
170 | * @return array |
171 | */ | |
6a488035 TO |
172 | public function getUserDashboardElement() { |
173 | return array(); | |
174 | } | |
175 | ||
4c6ce474 | 176 | /** |
e7c15cb6 | 177 | * @inheritDoc |
4c6ce474 EM |
178 | * @return array |
179 | */ | |
6a488035 | 180 | public function registerTab() { |
e547f744 | 181 | return array( |
353ffa53 | 182 | 'title' => ts('Cases'), |
6a488035 TO |
183 | 'url' => 'case', |
184 | 'weight' => 50, | |
185 | ); | |
186 | } | |
187 | ||
4c6ce474 | 188 | /** |
e7c15cb6 | 189 | * @inheritDoc |
4c6ce474 EM |
190 | * @return array |
191 | */ | |
6a488035 | 192 | public function registerAdvancedSearchPane() { |
e547f744 | 193 | return array( |
353ffa53 | 194 | 'title' => ts('Cases'), |
6a488035 TO |
195 | 'weight' => 50, |
196 | ); | |
197 | } | |
198 | ||
4c6ce474 | 199 | /** |
e7c15cb6 | 200 | * @inheritDoc |
4c6ce474 EM |
201 | * @return null |
202 | */ | |
6a488035 TO |
203 | public function getActivityTypes() { |
204 | return NULL; | |
205 | } | |
206 | ||
4c6ce474 | 207 | /** |
fe482240 | 208 | * add shortcut to Create New. |
4c6ce474 EM |
209 | * @param $shortCuts |
210 | */ | |
6a488035 TO |
211 | public function creatNewShortcut(&$shortCuts) { |
212 | if (CRM_Core_Permission::check('access all cases and activities') || | |
213 | CRM_Core_Permission::check('add cases') | |
214 | ) { | |
215 | $atype = CRM_Core_OptionGroup::getValue('activity_type', | |
216 | 'Open Case', | |
217 | 'name' | |
218 | ); | |
219 | if ($atype) { | |
220 | $shortCuts = array_merge($shortCuts, array( | |
e547f744 | 221 | array( |
353ffa53 TO |
222 | 'path' => 'civicrm/case/add', |
223 | 'query' => "reset=1&action=add&atype=$atype&context=standalone", | |
224 | 'ref' => 'new-case', | |
225 | 'title' => ts('Case'), | |
c301f76e | 226 | ), |
353ffa53 | 227 | )); |
6a488035 TO |
228 | } |
229 | } | |
230 | } | |
2bc3bd8f TO |
231 | |
232 | /** | |
233 | * (Setting Callback) | |
234 | * Respond to changes in the "enable_components" setting | |
235 | * | |
236 | * If CiviCase is being enabled, load the case related sample data | |
237 | * | |
64bd5a0e TO |
238 | * @param array $oldValue |
239 | * List of component names. | |
240 | * @param array $newValue | |
241 | * List of component names. | |
242 | * @param array $metadata | |
243 | * Specification of the setting (per *.settings.php). | |
2bc3bd8f TO |
244 | */ |
245 | public static function onToggleComponents($oldValue, $newValue, $metadata) { | |
e6d720bb TO |
246 | if ( |
247 | in_array('CiviCase', $newValue) | |
248 | && | |
249 | (!$oldValue || !in_array('CiviCase', $oldValue)) | |
2bc3bd8f | 250 | ) { |
e547f744 | 251 | $pathToCaseSampleTpl = __DIR__ . '/xml/configuration.sample/'; |
02b862ef | 252 | CRM_Admin_Form_Setting_Component::loadCaseSampleData($pathToCaseSampleTpl . 'case_sample.mysql.tpl'); |
2bc3bd8f TO |
253 | if (!CRM_Case_BAO_Case::createCaseViews()) { |
254 | $msg = ts("Could not create the MySQL views for CiviCase. Your mysql user needs to have the 'CREATE VIEW' permission"); | |
255 | CRM_Core_Error::fatal($msg); | |
256 | } | |
257 | } | |
258 | } | |
96025800 | 259 | |
6a488035 | 260 | } |