3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
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() {
63 $result['crmCaseType'] = array(
65 'js' => array('ang/crmCaseType.js'),
66 'css' => array('ang/crmCaseType.css'),
67 'partials' => array('ang/crmCaseType'),
70 CRM_Core_Resources
::singleton()->addSetting(array(
71 'crmCaseType' => array(
72 'REL_TYPE_CNAME' => CRM_Case_XMLProcessor
::REL_TYPE_CNAME
,
81 * @throws CRM_Core_Exception
83 public function getManagedEntities() {
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())
94 * @param bool $getAllUnconditionally
95 * @param bool $descriptions
96 * Whether to return permission descriptions
100 public function getPermissions($getAllUnconditionally = FALSE, $descriptions = FALSE) {
101 $permissions = array(
102 'delete in CiviCase' => array(
103 ts('delete in CiviCase'),
106 'administer CiviCase' => array(
107 ts('administer CiviCase'),
108 ts('Define case types, access deleted cases'),
110 'access my cases and activities' => array(
111 ts('access my cases and activities'),
112 ts('View and edit only those cases managed by this user'),
114 'access all cases and activities' => array(
115 ts('access all cases and activities'),
116 ts('View and edit all cases (for visible contacts)'),
118 'add cases' => array(
120 ts('Open a new case'),
124 if (!$descriptions) {
125 foreach ($permissions as $name => $attr) {
126 $permissions[$name] = array_shift($attr);
136 public function getReferenceCounts($dao) {
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
);
146 'name' => 'casetypexml:activities',
147 'type' => 'casetypexml',
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
});
159 'name' => 'casetypexml:relationships',
160 'type' => 'casetypexml',
172 public function getUserDashboardElement() {
180 public function registerTab() {
182 'title' => ts('Cases'),
192 public function registerAdvancedSearchPane() {
194 'title' => ts('Cases'),
203 public function getActivityTypes() {
208 * add shortcut to Create New.
211 public function creatNewShortcut(&$shortCuts) {
212 if (CRM_Core_Permission
::check('access all cases and activities') ||
213 CRM_Core_Permission
::check('add cases')
215 $atype = CRM_Core_OptionGroup
::getValue('activity_type',
220 $shortCuts = array_merge($shortCuts, array(
222 'path' => 'civicrm/case/add',
223 'query' => "reset=1&action=add&atype=$atype&context=standalone",
225 'title' => ts('Case'),
234 * Respond to changes in the "enable_components" setting
236 * If CiviCase is being enabled, load the case related sample data
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).
245 public static function onToggleComponents($oldValue, $newValue, $metadata) {
247 in_array('CiviCase', $newValue)
249 (!$oldValue ||
!in_array('CiviCase', $oldValue))
251 $pathToCaseSampleTpl = __DIR__
. '/xml/configuration.sample/';
252 CRM_Admin_Form_Setting_Component
::loadCaseSampleData($pathToCaseSampleTpl . 'case_sample.mysql.tpl');
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);