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
{
42 protected $keyword = 'case';
48 public function getInfo() {
51 'translatedName' => ts('CiviCase'),
52 'title' => ts('CiviCase Engine'),
54 'showActivitiesInCore' => 0,
61 public function getAngularModules() {
65 $result['crmCaseType'] = include "$civicrm_root/ang/crmCaseType.ang.php";
72 * @throws CRM_Core_Exception
74 public function getManagedEntities() {
75 $entities = array_merge(
76 CRM_Case_ManagedEntities
::createManagedCaseTypes(),
77 CRM_Case_ManagedEntities
::createManagedActivityTypes(CRM_Case_XMLRepository
::singleton(), CRM_Core_ManagedEntities
::singleton()),
78 CRM_Case_ManagedEntities
::createManagedRelationshipTypes(CRM_Case_XMLRepository
::singleton(), CRM_Core_ManagedEntities
::singleton())
85 * @param bool $getAllUnconditionally
86 * @param bool $descriptions
87 * Whether to return permission descriptions
91 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
93 'delete in CiviCase' => array(
94 ts('delete in CiviCase'),
97 'administer CiviCase' => array(
98 ts('administer CiviCase'),
99 ts('Define case types, access deleted cases'),
101 'access my cases and activities' => array(
102 ts('access my cases and activities'),
103 ts('View and edit only those cases managed by this user'),
105 'access all cases and activities' => array(
106 ts('access all cases and activities'),
107 ts('View and edit all cases (for visible contacts)'),
109 'add cases' => array(
111 ts('Open a new case'),
115 if (!$descriptions) {
116 foreach ($permissions as $name => $attr) {
117 $permissions[$name] = array_shift($attr);
127 public function getReferenceCounts($dao) {
129 if ($dao instanceof CRM_Core_DAO_OptionValue
) {
130 /** @var $dao CRM_Core_DAO_OptionValue */
131 $activity_type_gid = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_type', 'id', 'name');
132 if ($activity_type_gid == $dao->option_group_id
) {
133 $count = CRM_Case_XMLRepository
::singleton()
134 ->getActivityReferenceCount($dao->name
);
137 'name' => 'casetypexml:activities',
138 'type' => 'casetypexml',
144 elseif ($dao instanceof CRM_Contact_DAO_RelationshipType
) {
145 /** @var $dao CRM_Contact_DAO_RelationshipType */
146 $count = CRM_Case_XMLRepository
::singleton()
147 ->getRelationshipReferenceCount($dao->{CRM_Case_XMLProcessor
::REL_TYPE_CNAME
});
150 'name' => 'casetypexml:relationships',
151 'type' => 'casetypexml',
163 public function getUserDashboardElement() {
171 public function registerTab() {
173 'title' => ts('Cases'),
183 public function getIcon() {
184 return 'crm-i fa-folder-open-o';
191 public function registerAdvancedSearchPane() {
193 'title' => ts('Cases'),
202 public function getActivityTypes() {
207 * add shortcut to Create New.
210 public function creatNewShortcut(&$shortCuts) {
211 if (CRM_Core_Permission
::check('access all cases and activities') ||
212 CRM_Core_Permission
::check('add cases')
214 $activityType = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Open Case');
216 $shortCuts = array_merge($shortCuts, array(
218 'path' => 'civicrm/case/add',
219 'query' => "reset=1&action=add&atype={$activityType}&context=standalone",
221 'title' => ts('Case'),
230 * Respond to changes in the "enable_components" setting
232 * If CiviCase is being enabled, load the case related sample data
234 * @param array $oldValue
235 * List of component names.
236 * @param array $newValue
237 * List of component names.
238 * @param array $metadata
239 * Specification of the setting (per *.settings.php).
241 public static function onToggleComponents($oldValue, $newValue, $metadata) {
243 in_array('CiviCase', $newValue)
245 (!$oldValue ||
!in_array('CiviCase', $oldValue))
247 $pathToCaseSampleTpl = __DIR__
. '/xml/configuration.sample/';
248 CRM_Admin_Form_Setting_Component
::loadCaseSampleData($pathToCaseSampleTpl . 'case_sample.mysql.tpl');
249 if (!CRM_Case_BAO_Case
::createCaseViews()) {
250 $msg = ts("Could not create the MySQL views for CiviCase. Your mysql user needs to have the 'CREATE VIEW' permission");
251 CRM_Core_Error
::fatal($msg);
258 * Array(string $value => string $label).
260 public static function getRedactOptions() {
262 'default' => ts('Default'),
263 '0' => ts('Do not redact emails'),
264 '1' => ts('Redact emails'),
270 * Array(string $value => string $label).
272 public static function getMultiClientOptions() {
274 'default' => ts('Default'),
275 '0' => ts('Single client per case'),
276 '1' => ts('Multiple client per case'),
282 * Array(string $value => string $label).
284 public static function getSortOptions() {
286 'default' => ts('Default'),
287 '0' => ts('Definition order'),
288 '1' => ts('Alphabetical order'),