Merge pull request #5953 from eileenmcnaughton/CRM-16555-4
[civicrm-core.git] / CRM / Case / XMLRepository.php
index d0c5a88ff0367ec25011eb6b8a3b97b45415d078..324a8c069345516c5bcc47dd06e967fe7a629c98 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  * The XMLRepository is responsible for loading XML for case-types.
@@ -65,7 +65,7 @@ class CRM_Case_XMLRepository {
   }
 
   /**
-   * @param array<String,SimpleXMLElement> $xml
+   * @param array <String,SimpleXMLElement> $xml
    */
   public function __construct($allCaseTypes = NULL, $xml = array()) {
     $this->allCaseTypes = $allCaseTypes;
@@ -98,7 +98,8 @@ class CRM_Case_XMLRepository {
       $fileXml = $this->retrieveFile($caseType);
       if ($fileXml) {
         $this->xml[$caseType] = $fileXml;
-      } else {
+      }
+      else {
         return FALSE;
       }
     }
@@ -137,9 +138,11 @@ class CRM_Case_XMLRepository {
 
   /**
    * @param string $caseType
-   * @return null|string file path
+   * @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)) {
@@ -254,7 +257,8 @@ 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
    */
   public function getActivityReferenceCount($activityType) {
@@ -273,7 +277,8 @@ 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
    */
   public function getRelationshipReferenceCount($relationshipTypeName) {