CRM/Case/Info.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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  +--------------------------------------------------------------------+
  26 */
  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
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * $Id$
  36  *
  37  */
  38 class CRM_Case_Info extends CRM_Core_Component_Info {
  39
  40
  41   // docs inherited from interface
  42   protected $keyword = 'case';
  43
  44   // docs inherited from interface
  45   /**
  46    * @return array
  47    */
  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
  58   /**
  59    * {@inheritDoc}
  60    */
  61   public function getAngularModules() {
  62     $result = array();
  63     $result['crmCaseType'] = array(
  64       'ext' => 'civicrm',
  65       'js' => array('js/angular-crmCaseType.js'),
  66       'css' => array('css/angular-crmCaseType.css'),
  67     );
  68     // Need full OptionValue records
  69     $actStatuses = civicrm_api3('OptionValue', 'get', array('option_group_id' => 'activity_status'));
  70     $actTypes = civicrm_api3('OptionValue', 'get', array('option_group_id' => 'activity_type'));
  71     $relTypes = civicrm_api3('RelationshipType', 'get', array());
  72
  73     CRM_Core_Resources::singleton()->addSetting(array(
  74       'crmCaseType' => array(
  75         'actStatuses' => array_values($actStatuses['values']),
  76         'actTypes' => array_values($actTypes['values']),
  77         'relTypes' => array_values($relTypes['values']),
  78         //CRM_Core_PseudoConstant::activityType(TRUE, TRUE, FALSE, 'name'),
  79
  80       ),
  81     ));
  82     return $result;
  83   }
  84
  85   // docs inherited from interface
  86   /**
  87    * @return array
  88    * @throws CRM_Core_Exception
  89    */
  90   public function getManagedEntities() {
  91     $entities = array_merge(
  92       CRM_Case_ManagedEntities::createManagedCaseTypes(),
  93       CRM_Case_ManagedEntities::createManagedActivityTypes(CRM_Case_XMLRepository::singleton(), CRM_Core_ManagedEntities::singleton()),
  94       CRM_Case_ManagedEntities::createManagedRelationshipTypes(CRM_Case_XMLRepository::singleton(), CRM_Core_ManagedEntities::singleton())
  95     );
  96     return $entities;
  97   }
  98
  99   // docs inherited from interface
 100   /**
 101    * @param bool $getAllUnconditionally
 102    *
 103    * @return array
 104    */
 105   public function getPermissions($getAllUnconditionally = FALSE) {
 106     return array(
 107       'delete in CiviCase',
 108       'administer CiviCase',
 109       'access my cases and activities',
 110       'access all cases and activities',
 111       'add cases',
 112     );
 113   }
 114
 115   /**
 116    * {@inheritdoc}
 117    */
 118   public function getReferenceCounts($dao) {
 119     $result = array();
 120     if ($dao instanceof CRM_Core_DAO_OptionValue) {
 121       /** @var $dao CRM_Core_DAO_OptionValue */
 122       $activity_type_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', 'activity_type', 'id', 'name');
 123       if ($activity_type_gid == $dao->option_group_id) {
 124         $count = CRM_Case_XMLRepository::singleton()
 125           ->getActivityReferenceCount($dao->name);
 126         if ($count > 0) {
 127           $result[] = array(
 128             'name' => 'casetypexml:activities',
 129             'type' => 'casetypexml',
 130             'count' => $count,
 131           );
 132         }
 133       }
 134     }
 135     elseif ($dao instanceof CRM_Contact_DAO_RelationshipType) {
 136       /** @var $dao CRM_Contact_DAO_RelationshipType */
 137       $count = CRM_Case_XMLRepository::singleton()
 138         ->getRelationshipReferenceCount($dao->{CRM_Case_XMLProcessor::REL_TYPE_CNAME});
 139       if ($count > 0) {
 140         $result[] = array(
 141           'name' => 'casetypexml:relationships',
 142           'type' => 'casetypexml',
 143           'count' => $count,
 144         );
 145       }
 146     }
 147     return $result;
 148   }
 149
 150   // docs inherited from interface
 151   /**
 152    * @return array
 153    */
 154   public function getUserDashboardElement() {
 155     return array();
 156   }
 157
 158   // docs inherited from interface
 159   /**
 160    * @return array
 161    */
 162   public function registerTab() {
 163     return array('title' => ts('Cases'),
 164       'url' => 'case',
 165       'weight' => 50,
 166     );
 167   }
 168
 169   // docs inherited from interface
 170   /**
 171    * @return array
 172    */
 173   public function registerAdvancedSearchPane() {
 174     return array('title' => ts('Cases'),
 175       'weight' => 50,
 176     );
 177   }
 178
 179   // docs inherited from interface
 180   /**
 181    * @return null
 182    */
 183   public function getActivityTypes() {
 184     return NULL;
 185   }
 186
 187   // add shortcut to Create New
 188   /**
 189    * @param $shortCuts
 190    */
 191   public function creatNewShortcut(&$shortCuts) {
 192     if (CRM_Core_Permission::check('access all cases and activities') ||
 193       CRM_Core_Permission::check('add cases')
 194     ) {
 195       $atype = CRM_Core_OptionGroup::getValue('activity_type',
 196         'Open Case',
 197         'name'
 198       );
 199       if ($atype) {
 200         $shortCuts = array_merge($shortCuts, array(
 201           array('path' => 'civicrm/case/add',
 202               'query' => "reset=1&action=add&atype=$atype&context=standalone",
 203               'ref' => 'new-case',
 204               'title' => ts('Case'),
 205             )));
 206       }
 207     }
 208   }
 209
 210   /**
 211    * (Setting Callback)
 212    * Respond to changes in the "enable_components" setting
 213    *
 214    * If CiviCase is being enabled, load the case related sample data
 215    *
 216    * @param array $oldValue List of component names
 217    * @param array $newValue List of component names
 218    * @param array $metadata Specification of the setting (per *.settings.php)
 219    */
 220   public static function onToggleComponents($oldValue, $newValue, $metadata) {
 221     if (
 222       in_array('CiviCase', $newValue)
 223       &&
 224       (!$oldValue || !in_array('CiviCase', $oldValue))
 225     ) {
 226       $config = CRM_Core_Config::singleton();
 227       CRM_Admin_Form_Setting_Component::loadCaseSampleData($config->dsn, $config->sqlDir . 'case_sample.mysql');
 228       if (!CRM_Case_BAO_Case::createCaseViews()) {
 229         $msg = ts("Could not create the MySQL views for CiviCase. Your mysql user needs to have the 'CREATE VIEW' permission");
 230         CRM_Core_Error::fatal($msg);
 231       }
 232     }
 233   }
 234 }
 235