3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 introduces component to the system and provides all the
30 * information about it. It needs to extend CRM_Core_Component_Info
34 * @copyright CiviCRM LLC (c) 2004-2019
36 class CRM_Case_Info
extends CRM_Core_Component_Info
{
43 protected $keyword = 'case';
49 public function getInfo() {
52 'translatedName' => ts('CiviCase'),
53 'title' => ts('CiviCase Engine'),
55 'showActivitiesInCore' => 0,
62 public function getAngularModules() {
66 $result['crmCaseType'] = include "$civicrm_root/ang/crmCaseType.ang.php";
73 * @throws CRM_Core_Exception
75 public function getManagedEntities() {
76 $entities = array_merge(
77 CRM_Case_ManagedEntities
::createManagedCaseTypes(),
78 CRM_Case_ManagedEntities
::createManagedActivityTypes(CRM_Case_XMLRepository
::singleton(), CRM_Core_ManagedEntities
::singleton()),
79 CRM_Case_ManagedEntities
::createManagedRelationshipTypes(CRM_Case_XMLRepository
::singleton(), CRM_Core_ManagedEntities
::singleton())
86 * @param bool $getAllUnconditionally
87 * @param bool $descriptions
88 * Whether to return permission descriptions
92 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
94 'delete in CiviCase' => [
95 ts('delete in CiviCase'),
98 'administer CiviCase' => [
99 ts('administer CiviCase'),
100 ts('Define case types, access deleted cases'),
102 'access my cases and activities' => [
103 ts('access my cases and activities'),
104 ts('View and edit only those cases managed by this user'),
106 'access all cases and activities' => [
107 ts('access all cases and activities'),
108 ts('View and edit all cases (for visible contacts)'),
112 ts('Open a new case'),
116 if (!$descriptions) {
117 foreach ($permissions as $name => $attr) {
118 $permissions[$name] = array_shift($attr);
128 public function getReferenceCounts($dao) {
130 if ($dao instanceof CRM_Core_DAO_OptionValue
) {
131 /** @var $dao CRM_Core_DAO_OptionValue */
132 $activity_type_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_type', 'id', 'name');
133 if ($activity_type_gid == $dao->option_group_id
) {
134 $count = CRM_Case_XMLRepository
::singleton()
135 ->getActivityReferenceCount($dao->name
);
138 'name' => 'casetypexml:activities',
139 'type' => 'casetypexml',
145 elseif ($dao instanceof CRM_Contact_DAO_RelationshipType
) {
146 /** @var $dao CRM_Contact_DAO_RelationshipType */
148 // Need to look both directions, but no need to translate case role
149 // direction from XML perspective to client-based perspective
150 $xmlRepo = CRM_Case_XMLRepository
::singleton();
151 $count = $xmlRepo->getRelationshipReferenceCount($dao->label_a_b
);
152 if ($dao->label_a_b
!= $dao->label_b_a
) {
153 $count +
= $xmlRepo->getRelationshipReferenceCount($dao->label_b_a
);
157 'name' => 'casetypexml:relationships',
158 'type' => 'casetypexml',
170 public function getUserDashboardElement() {
178 public function registerTab() {
180 'title' => ts('Cases'),
190 public function getIcon() {
191 return 'crm-i fa-folder-open-o';
198 public function registerAdvancedSearchPane() {
200 'title' => ts('Cases'),
209 public function getActivityTypes() {
214 * add shortcut to Create New.
217 public function creatNewShortcut(&$shortCuts) {
218 if (CRM_Core_Permission
::check('access all cases and activities') ||
219 CRM_Core_Permission
::check('add cases')
221 $activityType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Open Case');
223 $shortCuts = array_merge($shortCuts, [
225 'path' => 'civicrm/case/add',
226 'query' => "reset=1&action=add&atype={$activityType}&context=standalone",
228 'title' => ts('Case'),
237 * Respond to changes in the "enable_components" setting
239 * If CiviCase is being enabled, load the case related sample data
241 * @param array $oldValue
242 * List of component names.
243 * @param array $newValue
244 * List of component names.
245 * @param array $metadata
246 * Specification of the setting (per *.settings.php).
248 public static function onToggleComponents($oldValue, $newValue, $metadata) {
250 in_array('CiviCase', $newValue)
252 (!$oldValue ||
!in_array('CiviCase', $oldValue))
254 $pathToCaseSampleTpl = __DIR__
. '/xml/configuration.sample/';
255 self
::loadCaseSampleData($pathToCaseSampleTpl . 'case_sample.mysql.tpl');
256 if (!CRM_Case_BAO_Case
::createCaseViews()) {
257 $msg = ts("Could not create the MySQL views for CiviCase. Your mysql user needs to have the 'CREATE VIEW' permission");
258 CRM_Core_Error
::fatal($msg);
264 * Load case sample data.
266 * @param string $fileName
267 * @param bool $lineMode
269 public static function loadCaseSampleData($fileName, $lineMode = FALSE) {
270 $dao = new CRM_Core_DAO();
271 $db = $dao->getDatabaseConnection();
273 $domain = new CRM_Core_DAO_Domain();
275 $multiLingual = (bool) $domain->locales
;
276 $smarty = CRM_Core_Smarty
::singleton();
277 $smarty->assign('multilingual', $multiLingual);
278 $smarty->assign('locales', explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $domain->locales
));
282 $string = $smarty->fetch($fileName);
283 // change \r\n to fix windows issues
284 $string = str_replace("\r\n", "\n", $string);
286 //get rid of comments starting with # and --
288 $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
289 $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
291 $queries = preg_split('/;$/m', $string);
292 foreach ($queries as $query) {
293 $query = trim($query);
294 if (!empty($query)) {
295 $res = &$db->query($query);
296 if (PEAR
::isError($res)) {
297 die("Cannot execute $query: " . $res->getMessage());
303 $fd = fopen($fileName, "r");
304 while ($string = fgets($fd)) {
305 $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
306 $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
308 $string = trim($string);
309 if (!empty($string)) {
310 $res = &$db->query($string);
311 if (PEAR
::isError($res)) {
312 die("Cannot execute $string: " . $res->getMessage());
321 * Array(string $value => string $label).
323 public static function getRedactOptions() {
325 'default' => ts('Default'),
326 '0' => ts('Do not redact emails'),
327 '1' => ts('Redact emails'),
333 * Array(string $value => string $label).
335 public static function getMultiClientOptions() {
337 'default' => ts('Default'),
338 '0' => ts('Single client per case'),
339 '1' => ts('Multiple client per case'),
345 * Array(string $value => string $label).
347 public static function getSortOptions() {
349 'default' => ts('Default'),
350 '0' => ts('Definition order'),
351 '1' => ts('Alphabetical order'),