3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
34 * The XMLRepository is responsible for loading XML for case-types.
35 * It includes any bulk operations that apply across the list of all XML
36 * documents of all case-types.
38 class CRM_Case_XMLRepository
{
39 private static $singleton;
42 * @var array<String,SimpleXMLElement>
44 protected $xml = array();
49 protected $hookCache = NULL;
52 * @var array|NULL symbolic names of case-types
54 protected $allCaseTypes = NULL;
58 * @return CRM_Case_XMLRepository
60 public static function singleton($fresh = FALSE) {
61 if (!self
::$singleton ||
$fresh) {
62 self
::$singleton = new static();
64 return self
::$singleton;
68 * @param array<String,SimpleXMLElement> $xml
70 public function __construct($allCaseTypes = NULL, $xml = array()) {
71 $this->allCaseTypes
= $allCaseTypes;
76 * @param string $caseType
77 * @return SimpleXMLElement|FALSE
79 public function retrieve($caseType) {
80 // check if xml definition is defined in db
81 $definition = CRM_Core_DAO
::getFieldValue('CRM_Case_DAO_CaseType', $caseType, 'definition', 'name');
83 if (!empty($definition)) {
84 return simplexml_load_string($definition);
87 $caseType = CRM_Case_XMLProcessor
::mungeCaseType($caseType);
89 if (!CRM_Utils_Array
::value($caseType, $this->xml
)) {
90 // first check custom templates directory
93 if (!$fileName ||
!file_exists($fileName)) {
94 $caseTypesViaHook = $this->getCaseTypesViaHook();
95 if (isset($caseTypesViaHook[$caseType], $caseTypesViaHook[$caseType]['file'])) {
96 $fileName = $caseTypesViaHook[$caseType]['file'];
100 if (!$fileName ||
!file_exists($fileName)) {
101 $config = CRM_Core_Config
::singleton();
102 if (isset($config->customTemplateDir
) && $config->customTemplateDir
) {
103 // check if the file exists in the custom templates directory
104 $fileName = implode(DIRECTORY_SEPARATOR
,
106 $config->customTemplateDir
,
117 if (!$fileName ||
!file_exists($fileName)) {
118 if (!file_exists($fileName)) {
119 // check if file exists locally
120 $fileName = implode(DIRECTORY_SEPARATOR
,
130 if (!file_exists($fileName)) {
131 // check if file exists locally
132 $fileName = implode(DIRECTORY_SEPARATOR
,
136 'configuration.sample',
142 if (!file_exists($fileName)) {
148 $dom = new DomDocument();
149 $dom->load($fileName);
151 $this->xml
[$caseType] = simplexml_import_dom($dom);
153 return $this->xml
[$caseType];
158 * @see CRM_Utils_Hook::caseTypes
160 public function getCaseTypesViaHook() {
161 if ($this->hookCache
=== NULL) {
162 $this->hookCache
= array();
163 CRM_Utils_Hook
::caseTypes($this->hookCache
);
165 return $this->hookCache
;
169 * @return array<string> symbolic names of case-types
171 public function getAllCaseTypes() {
172 if ($this->allCaseTypes
=== NULL) {
173 $this->allCaseTypes
= CRM_Case_PseudoConstant
::caseType("name");
175 return $this->allCaseTypes
;
179 * @return array<string> symbolic-names of activity-types
181 public function getAllDeclaredActivityTypes() {
184 $p = new CRM_Case_XMLProcessor_Process();
185 foreach ($this->getAllCaseTypes() as $caseTypeName) {
186 $caseTypeXML = $this->retrieve($caseTypeName);
187 $result = array_merge($result, $p->getDeclaredActivityTypes($caseTypeXML));
190 $result = array_unique($result);
196 * @return array<string> symbolic-names of relationship-types
198 public function getAllDeclaredRelationshipTypes() {
201 $p = new CRM_Case_XMLProcessor_Process();
202 foreach ($this->getAllCaseTypes() as $caseTypeName) {
203 $caseTypeXML = $this->retrieve($caseTypeName);
204 $result = array_merge($result, $p->getDeclaredRelationshipTypes($caseTypeXML));
207 $result = array_unique($result);
213 * Determine the number of times a particular activity-type is
214 * referenced in CiviCase XML.
216 * @param string $activityType symbolic-name of an activity type
219 function getActivityReferenceCount($activityType) {
220 $p = new CRM_Case_XMLProcessor_Process();
222 foreach ($this->getAllCaseTypes() as $caseTypeName) {
223 $caseTypeXML = $this->retrieve($caseTypeName);
224 if (in_array($activityType, $p->getDeclaredActivityTypes($caseTypeXML))) {
232 * Determine the number of times a particular activity-type is
233 * referenced in CiviCase XML.
235 * @param string $relationshipTypeName symbolic-name of a relationship-type
238 function getRelationshipReferenceCount($relationshipTypeName) {
239 $p = new CRM_Case_XMLProcessor_Process();
241 foreach ($this->getAllCaseTypes() as $caseTypeName) {
242 $caseTypeXML = $this->retrieve($caseTypeName);
243 if (in_array($relationshipTypeName, $p->getDeclaredRelationshipTypes($caseTypeXML))) {