Merge branch 4.5 into master

[civicrm-core.git] / CRM / Case / XMLRepository.php

diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php
index 5193f468c6ea024a317c58006e90ceec38333478..8ec73aabfef4655a6ecbf56a14db450aae77d3a3 100644 (file)
--- a/CRM/Case/XMLRepository.php
+++ b/CRM/Case/XMLRepository.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -81,42 +81,67 @@ class CRM_Case_XMLRepository {
     $definition = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType, 'definition', 'name');
 
     if (!empty($definition)) {
-      return simplexml_load_string($definition);
+      list ($xml, $error) = CRM_Utils_XML::parseString($definition);
+      if (!$xml) {
+        throw new CRM_Core_Exception("Failed to parse CaseType XML: $error");
+      }
+      return $xml;
     }
 
-    if (!CRM_Case_BAO_CaseType::isValidName($caseType)) {
-      // perhaps caller provider a the label instead of the name?
-      throw new CRM_Core_Exception("Cannot load caseType with malformed name [$caseType]");
-    }
+    // TODO In 4.6 or 5.0, remove support for weird machine-names
+    //if (!CRM_Case_BAO_CaseType::isValidName($caseType)) {
+    //  // perhaps caller provider a the label instead of the name?
+    //  throw new CRM_Core_Exception("Cannot load caseType with malformed name [$caseType]");
+    //}
 
     if (!CRM_Utils_Array::value($caseType, $this->xml)) {
-      // Search for a file based directly on the $caseType name
-      $fileName = $this->findXmlFile($caseType);
-
-      // For backward compatibility, also search for double-mungd file names
-      // TODO In 4.6 or 5.0, remove support for loading double-munged file names
-      if (!$fileName || !file_exists($fileName)) {
-        $fileName = $this->findXmlFile(CRM_Case_XMLProcessor::mungeCaseType($caseType));
+      $fileXml = $this->retrieveFile($caseType);
+      if ($fileXml) {
+        $this->xml[$caseType] = $fileXml;
       }
-
-      if (!$fileName || !file_exists($fileName)) {
+      else {
         return FALSE;
       }
+    }
+    return $this->xml[$caseType];
+  }
+
+  /**
+   * @param string $caseType
+   * @return SimpleXMLElement|FALSE
+   */
+  public function retrieveFile($caseType) {
+    $fileName = NULL;
+    $fileXml = NULL;
+
+    if (CRM_Case_BAO_CaseType::isValidName($caseType)) {
+      // Search for a file based directly on the $caseType name
+      $fileName = $this->findXmlFile($caseType);
+    }
+
+    // For backward compatibility, also search for double-munged file names
+    // TODO In 4.6 or 5.0, remove support for loading double-munged file names
+    if (!$fileName || !file_exists($fileName)) {
+      $fileName = $this->findXmlFile(CRM_Case_XMLProcessor::mungeCaseType($caseType));
+    }
 
+    if ($fileName && file_exists($fileName)) {
       // read xml file
       $dom = new DomDocument();
       $dom->load($fileName);
       $dom->xinclude();
-      $this->xml[$caseType] = simplexml_import_dom($dom);
+      $fileXml = simplexml_import_dom($dom);
     }
-    return $this->xml[$caseType];
+
+    return $fileXml;
   }
 
   /**
    * @param string $caseType
    * @return null|string file path
    */
-  public function findXmlFile($caseType) { // first check custom templates directory
+  public function findXmlFile($caseType) {
+    // first check custom templates directory
     $fileName = NULL;
 
     if (!$fileName || !file_exists($fileName)) {
@@ -231,10 +256,11 @@ class CRM_Case_XMLRepository {
    * Determine the number of times a particular activity-type is
    * referenced in CiviCase XML.
    *
-   * @param string $activityType symbolic-name of an activity type
+   * @param string $activityType
+   *   Symbolic-name of an activity type.
    * @return int
    */
-  function getActivityReferenceCount($activityType) {
+  public function getActivityReferenceCount($activityType) {
     $p = new CRM_Case_XMLProcessor_Process();
     $count = 0;
     foreach ($this->getAllCaseTypes() as $caseTypeName) {
@@ -250,10 +276,11 @@ class CRM_Case_XMLRepository {
    * Determine the number of times a particular activity-type is
    * referenced in CiviCase XML.
    *
-   * @param string $relationshipTypeName symbolic-name of a relationship-type
+   * @param string $relationshipTypeName
+   *   Symbolic-name of a relationship-type.
    * @return int
    */
-  function getRelationshipReferenceCount($relationshipTypeName) {
+  public function getRelationshipReferenceCount($relationshipTypeName) {
     $p = new CRM_Case_XMLProcessor_Process();
     $count = 0;
     foreach ($this->getAllCaseTypes() as $caseTypeName) {