Merge pull request #10360 from yashodha/CRM-20552

[civicrm-core.git] / Civi / CCase / Analyzer.php

diff --git a/Civi/CCase/Analyzer.php b/Civi/CCase/Analyzer.php
index f958eb663af1eff6d5ef7374b049e4b54f1206c3..bd67838321d8ab798bce271b732d14104c72ebe2 100644 (file)
--- a/Civi/CCase/Analyzer.php
+++ b/Civi/CCase/Analyzer.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,9 +23,14 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 namespace Civi\CCase;
 
+/**
+ * Class Analyzer
+ *
+ * @package Civi\CCase
+ */
 class Analyzer {
   /**
    * @var int
@@ -57,6 +62,9 @@ class Analyzer {
    */
   private $indices;
 
+  /**
+   * @param $caseId
+   */
   public function __construct($caseId) {
     $this->caseId = $caseId;
     $this->flush();
@@ -84,7 +92,7 @@ class Analyzer {
       $activityStatusGroup = civicrm_api3('option_group', 'get', array('name' => 'activity_status'));
       $activityStatus = array(
         'name' => $status,
-        'option_group_id' => $activityStatusGroup['id']
+        'option_group_id' => $activityStatusGroup['id'],
       );
       $activityStatusID = civicrm_api3('option_value', 'get', $activityStatus);
       $activityStatusID = $activityStatusID['values'][$activityStatusID['id']]['value'];
@@ -98,7 +106,7 @@ class Analyzer {
   }
 
   /**
-   * Get a list of all activities in the case
+   * Get a list of all activities in the case.
    *
    * @return array
    *   list of activity records (api/v3 format)
@@ -123,7 +131,7 @@ class Analyzer {
   }
 
   /**
-   * Get a single activity record by type
+   * Get a single activity record by type.
    *
    * @param string $type
    * @throws \Civi\CCase\Exception\MultipleActivityException
@@ -167,6 +175,7 @@ class Analyzer {
 
   /**
    * @return string
+   * @throws \CRM_Core_Exception
    */
   public function getCaseType() {
     if ($this->caseType === NULL) {
@@ -197,7 +206,7 @@ class Analyzer {
   }
 
   /**
-   * @return SimpleXMLElement|NULL
+   * @return \SimpleXMLElement|NULL
    */
   public function getXml() {
     if ($this->xml === NULL) {
@@ -207,9 +216,7 @@ class Analyzer {
   }
 
   /**
-   * Flush any cached information
-   *
-   * @return void
+   * Flush any cached information.
    */
   public function flush() {
     $this->case = NULL;
@@ -217,4 +224,5 @@ class Analyzer {
     $this->activities = NULL;
     $this->indices = array();
   }
+
 }