3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 list ($xml, $error) = CRM_Utils_XML
::parseString($definition);
86 throw new CRM_Core_Exception("Failed to parse CaseType XML: $error");
91 // TODO In 4.6 or 5.0, remove support for weird machine-names
92 //if (!CRM_Case_BAO_CaseType::isValidName($caseType)) {
93 // // perhaps caller provider a the label instead of the name?
94 // throw new CRM_Core_Exception("Cannot load caseType with malformed name [$caseType]");
97 if (!CRM_Utils_Array
::value($caseType, $this->xml
)) {
98 $fileXml = $this->retrieveFile($caseType);
100 $this->xml
[$caseType] = $fileXml;
106 return $this->xml
[$caseType];
110 * @param string $caseType
111 * @return SimpleXMLElement|FALSE
113 public function retrieveFile($caseType) {
117 if (CRM_Case_BAO_CaseType
::isValidName($caseType)) {
118 // Search for a file based directly on the $caseType name
119 $fileName = $this->findXmlFile($caseType);
122 // For backward compatibility, also search for double-munged file names
123 // TODO In 4.6 or 5.0, remove support for loading double-munged file names
124 if (!$fileName ||
!file_exists($fileName)) {
125 $fileName = $this->findXmlFile(CRM_Case_XMLProcessor
::mungeCaseType($caseType));
128 if ($fileName && file_exists($fileName)) {
130 $dom = new DomDocument();
131 $dom->load($fileName);
133 $fileXml = simplexml_import_dom($dom);
140 * @param string $caseType
141 * @return null|string file path
143 public function findXmlFile($caseType) {
144 // first check custom templates directory
147 if (!$fileName ||
!file_exists($fileName)) {
148 $caseTypesViaHook = $this->getCaseTypesViaHook();
149 if (isset($caseTypesViaHook[$caseType], $caseTypesViaHook[$caseType]['file'])) {
150 $fileName = $caseTypesViaHook[$caseType]['file'];
154 if (!$fileName ||
!file_exists($fileName)) {
155 $config = CRM_Core_Config
::singleton();
156 if (isset($config->customTemplateDir
) && $config->customTemplateDir
) {
157 // check if the file exists in the custom templates directory
158 $fileName = implode(DIRECTORY_SEPARATOR
,
160 $config->customTemplateDir
,
171 if (!$fileName ||
!file_exists($fileName)) {
172 if (!file_exists($fileName)) {
173 // check if file exists locally
174 $fileName = implode(DIRECTORY_SEPARATOR
,
184 if (!file_exists($fileName)) {
185 // check if file exists locally
186 $fileName = implode(DIRECTORY_SEPARATOR
,
190 'configuration.sample',
196 return file_exists($fileName) ?
$fileName : NULL;
201 * @see CRM_Utils_Hook::caseTypes
203 public function getCaseTypesViaHook() {
204 if ($this->hookCache
=== NULL) {
205 $this->hookCache
= array();
206 CRM_Utils_Hook
::caseTypes($this->hookCache
);
208 return $this->hookCache
;
212 * @return array<string> symbolic names of case-types
214 public function getAllCaseTypes() {
215 if ($this->allCaseTypes
=== NULL) {
216 $this->allCaseTypes
= CRM_Case_PseudoConstant
::caseType("name");
218 return $this->allCaseTypes
;
222 * @return array<string> symbolic-names of activity-types
224 public function getAllDeclaredActivityTypes() {
227 $p = new CRM_Case_XMLProcessor_Process();
228 foreach ($this->getAllCaseTypes() as $caseTypeName) {
229 $caseTypeXML = $this->retrieve($caseTypeName);
230 $result = array_merge($result, $p->getDeclaredActivityTypes($caseTypeXML));
233 $result = array_unique($result);
239 * @return array<string> symbolic-names of relationship-types
241 public function getAllDeclaredRelationshipTypes() {
244 $p = new CRM_Case_XMLProcessor_Process();
245 foreach ($this->getAllCaseTypes() as $caseTypeName) {
246 $caseTypeXML = $this->retrieve($caseTypeName);
247 $result = array_merge($result, $p->getDeclaredRelationshipTypes($caseTypeXML));
250 $result = array_unique($result);
256 * Determine the number of times a particular activity-type is
257 * referenced in CiviCase XML.
259 * @param string $activityType
260 * Symbolic-name of an activity type.
263 public function getActivityReferenceCount($activityType) {
264 $p = new CRM_Case_XMLProcessor_Process();
266 foreach ($this->getAllCaseTypes() as $caseTypeName) {
267 $caseTypeXML = $this->retrieve($caseTypeName);
268 if (in_array($activityType, $p->getDeclaredActivityTypes($caseTypeXML))) {
276 * Determine the number of times a particular activity-type is
277 * referenced in CiviCase XML.
279 * @param string $relationshipTypeName
280 * Symbolic-name of a relationship-type.
283 public function getRelationshipReferenceCount($relationshipTypeName) {
284 $p = new CRM_Case_XMLProcessor_Process();
286 foreach ($this->getAllCaseTypes() as $caseTypeName) {
287 $caseTypeXML = $this->retrieve($caseTypeName);
288 if (in_array($relationshipTypeName, $p->getDeclaredRelationshipTypes($caseTypeXML))) {