minor tidy-ups
[civicrm-core.git] / CRM / Case / BAO / Case.php
index 61cd49329c94e3ea3c0fd0e1d4bf1dd6df6db747..6c6601bbd9ad82a93ce819928b5ec920559327e3 100644 (file)
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  */
 
 /**
- * This class contains the functions for Case Management
+ * This class contains the functions for Case Management.
  *
  */
 class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
 
   /**
-   * Static field for all the case information that we can potentially export
+   * Static field for all the case information that we can potentially export.
    *
    * @var array
-   * @static
    */
   static $_exportableFields = NULL;
 
   /**
-   *
+   * Class constructor.
    */
   public function __construct() {
     parent::__construct();
@@ -65,16 +64,16 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * Takes an associative array and creates a case object
+   * Create a case object.
    *
-   * the function extract all the params it needs to initialize the create a
+   * The function extracts all the params it needs to initialize the create a
    * case object. the params array could contain additional unused name/value
    * pairs
    *
-   * @param array $params (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
-   * @return CRM_Case_BAO_Case object
-   * @static
+   * @return CRM_Case_BAO_Case
    */
   public static function add(&$params) {
     $caseDAO = new CRM_Case_DAO_Case();
@@ -84,14 +83,17 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
 
   /**
    * Given the list of params in the params array, fetch the object
-   * and store the values in the values array
+   * and store the values in the values array.
    *
-   * @param array $params input parameters to find object
-   * @param array $values output values of the object
-   * @param array $ids    the array that holds all the db ids
-   *
-   * @return CRM_Case_BAO_Case|null the found object or null
-   * @static
+   * @param array $params
+   *   Input parameters to find object.
+   * @param array $values
+   *   Output values of the object.
+   * @param array $ids
+   *   The array that holds all the db ids.
+   *
+   * @return CRM_Case_BAO_Case|null
+   *   The found object or null
    */
   public static function &getValues(&$params, &$values, &$ids) {
     $case = new CRM_Case_BAO_Case();
@@ -107,12 +109,12 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * Takes an associative array and creates a case object
+   * Takes an associative array and creates a case object.
    *
-   * @param array $params (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference) an assoc array of name/value pairs.
    *
-   * @return CRM_Case_BAO_Case object
-   * @static
+   * @return CRM_Case_BAO_Case
    */
   public static function &create(&$params) {
     $transaction = new CRM_Core_Transaction();
@@ -151,9 +153,10 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * Create case contact record
+   * Create case contact record.
    *
-   * @param array    case_id, contact_id
+   * @param array $params
+   *   case_id, contact_id
    *
    * @return object
    */
@@ -193,11 +196,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * Delet case contact record
-   *
-   * @param int    case_id
+   * Delete case contact record.
    *
-   * @return Void
+   * @param int $caseID
    */
   public static function deleteCaseContact($caseID) {
     $caseContact = new CRM_Case_DAO_CaseContact();
@@ -213,12 +214,18 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * This function is used to convert associative array names to values
-   * and vice-versa.
+   * Convert associative array names to values and vice-versa.
    *
    * This function is used by both the web form layer and the api. Note that
    * the api needs the name => value conversion, also the view layer typically
    * requires value => name conversion
+   *
+   * @param array $defaults
+   * @param string $property
+   * @param array $lookup
+   * @param bool $reverse
+   *
+   * @return bool
    */
   public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
     $id = $property . '_id';
@@ -247,13 +254,15 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
    * full featured over a period of time. This is the inverse function of
    * create.  It also stores all the retrieved values in the default array
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the name / value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the name / value pairs.
    *                        in a hierarchical manner
-   * @param array $ids      (reference) the array that holds all the db ids
+   * @param array $ids
+   *   (reference) the array that holds all the db ids.
    *
-   * @return CRM_Case_BAO_Case object
-   * @static
+   * @return CRM_Case_BAO_Case
    */
   public static function retrieve(&$params, &$defaults, &$ids) {
     $case = CRM_Case_BAO_Case::getValues($params, $defaults, $ids);
@@ -264,9 +273,9 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
    * Process case activity add/delete
    * takes an associative array and
    *
-   * @param array $params (reference ) an assoc array of name/value pairs
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
    *
-   * @static
    */
   public static function processCaseActivity(&$params) {
     $caseActivityDAO = new CRM_Case_DAO_CaseActivity();
@@ -278,12 +287,12 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
   }
 
   /**
-   * Get the case subject for Activity
+   * Get the case subject for Activity.
    *
-   * @param int $activityId  activity id
+   * @param int $activityId
+   *   Activity id.
    *
-   * @return  case subject or null
-   * @static
+   * @return string|null
    */
   public static function getCaseSubject($activityId) {
     $caseActivity = new CRM_Case_DAO_CaseActivity();
@@ -298,11 +307,10 @@ class CRM_Case_BAO_Case extends CRM_Case_DAO_Case {
    * Get the case type.
    *
    * @param int $caseId
-   *
    * @param string $colName
    *
-   * @return  case type
-   * @static
+   * @return string
+   *   case type
    */
   public static function getCaseType($caseId, $colName = 'title') {
     $query = "
@@ -320,12 +328,13 @@ WHERE civicrm_case.id = %1";
    * Delete the record that are associated with this case
    * record are deleted from case
    *
-   * @param  int $caseId id of the case to delete
+   * @param int $caseId
+   *   Id of the case to delete.
    *
    * @param bool $moveToTrash
    *
-   * @return bool is successful
-   * @static
+   * @return bool
+   *   is successful
    */
   public static function deleteCase($caseId, $moveToTrash = FALSE) {
     CRM_Utils_Hook::pre('delete', 'Case', $caseId, CRM_Core_DAO::$_nullArray);
@@ -371,13 +380,14 @@ WHERE civicrm_case.id = %1";
   }
 
   /**
-   * Enable disable case related relationships
+   * Enable disable case related relationships.
    *
-   * @param int $caseId case id
-   * @param boolean $enable action
+   * @param int $caseId
+   *   Case id.
+   * @param bool $enable
+   *   Action.
    *
    * @return void
-   * @static
    */
   public static function enableDisableCaseRelationships($caseId, $enable) {
     $contactIds = self::retrieveContactIdsByCaseId($caseId);
@@ -396,12 +406,12 @@ WHERE civicrm_case.id = %1";
   }
 
   /**
-   * Delete the activities related to case
+   * Delete the activities related to case.
    *
-   * @param  int $activityId id of the activity
+   * @param int $activityId
+   *   Id of the activity.
    *
    * @return void
-   * @static
    */
   public static function deleteCaseActivity($activityId) {
     $case = new CRM_Case_DAO_CaseActivity();
@@ -412,7 +422,8 @@ WHERE civicrm_case.id = %1";
   /**
    * Retrieve contact_id by case_id
    *
-   * @param int $caseId ID of the case
+   * @param int $caseId
+   *   ID of the case.
    *
    * @param int $contactID
    *
@@ -435,7 +446,7 @@ WHERE civicrm_case.id = %1";
   }
 
   /**
-   * Look up a case using an activity ID
+   * Look up a case using an activity ID.
    *
    * @param int $activityId
    *
@@ -459,11 +470,10 @@ WHERE civicrm_case.id = %1";
   /**
    * Retrieve contact names by caseId
    *
-   * @param int $caseId  ID of the case
+   * @param int $caseId
+   *   ID of the case.
    *
    * @return array
-   *
-   *
    */
   public static function getContactNames($caseId) {
     $contactNames = array();
@@ -501,14 +511,14 @@ WHERE civicrm_case.id = %1";
   }
 
   /**
-   * Retrieve case_id by contact_id
+   * Retrieve case_id by contact_id.
    *
    * @param int $contactID
-   * @param boolean $includeDeleted include the deleted cases in result
+   * @param bool $includeDeleted
+   *   Include the deleted cases in result.
    * @param null $caseType
    *
    * @return array
-   *
    */
   public static function retrieveCaseIdsByContactId($contactID, $includeDeleted = FALSE, $caseType = NULL) {
     $query = "
@@ -518,7 +528,7 @@ INNER JOIN civicrm_case ca ON cc.case_id = ca.id
 ";
     if (isset($caseType)) {
       $query .=
-"INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
+        "INNER JOIN civicrm_case_type ON civicrm_case_type.id = ca.case_type_id
 WHERE cc.contact_id = %1 AND civicrm_case_type.name = '{$caseType}'";
     }
     if (!isset($caseType)) {
@@ -588,8 +598,8 @@ t_act.id as case_recent_activity_id,
 t_act.act_type_name as case_recent_activity_type_name,
 t_act.act_type AS case_recent_activity_type ";
     }
-    elseif ( $type == 'any' ) {
-      $query .=  "
+    elseif ($type == 'any') {
+      $query .= "
 t_act.desired_date as case_activity_date,
 t_act.id as case_activity_id,
 t_act.act_type_name as case_activity_type_name,
@@ -641,7 +651,7 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
   LEFT JOIN civicrm_option_value aov ON ( aov.option_group_id = aog.id AND aov.value = act.activity_type_id )
 ) AS t_act ";
     }
-    elseif ( $type == 'any' ) {
+    elseif ($type == 'any') {
       $query .= " LEFT JOIN
 (
   SELECT ca4.case_id, act4.id AS id, act4.activity_date_time AS desired_date, act4.activity_type_id, act4.status_id, aov.name AS act_type_name, aov.label AS act_type
@@ -690,7 +700,7 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
     elseif ($type == 'recent') {
       $query .= " ORDER BY case_recent_activity_date ASC ";
     }
-    elseif ( $type == 'any' ) {
+    elseif ($type == 'any') {
       $query .= " ORDER BY case_activity_date ASC ";
     }
 
@@ -698,19 +708,19 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
   }
 
   /**
-   * Retrieve cases related to particular contact or whole contact
-   * used in Dashboad and Tab
+   * Retrieve cases related to particular contact or whole contact used in Dashboard and Tab.
    *
-   * @param boolean $allCases
+   * @param bool $allCases
    *
    * @param int $userID
    *
-   * @param String $type /upcoming,recent,all/
+   * @param string $type
+   *   /upcoming,recent,all/.
    *
    * @param string $context
    *
-   * @return array     Array of Cases
-   *
+   * @return array
+   *   Array of Cases
    */
   public static function getCases($allCases = TRUE, $userID = NULL, $type = 'upcoming', $context = 'dashboard') {
     $condition = NULL;
@@ -731,13 +741,12 @@ LEFT JOIN civicrm_option_group aog ON aog.name='activity_type'
       $allCases = FALSE;
     }
 
-
     $condition = " AND civicrm_case.is_deleted = 0 ";
 
     if (!$allCases) {
       $condition .= " AND case_relationship.contact_id_b = {$userID} ";
     }
-    if ( $type == 'upcoming' || $type == 'any' ) {
+    if ($type == 'upcoming' || $type == 'any') {
       $closedId = CRM_Core_OptionGroup::getValue('case_status', 'Closed', 'name');
       $condition .= "
 AND civicrm_case.status_id != $closedId";
@@ -781,7 +790,7 @@ AND civicrm_case.status_id != $closedId";
       $resultFields[] = 'case_recent_activity_type';
       $resultFields[] = 'case_recent_activity_id';
     }
-    elseif ( $type == 'any' ) {
+    elseif ($type == 'any') {
       $resultFields[] = 'case_activity_date';
       $resultFields[] = 'case_activity_type_name';
       $resultFields[] = 'case_activity_type';
@@ -791,7 +800,6 @@ AND civicrm_case.status_id != $closedId";
     // we're going to use the usual actions, so doesn't make sense to duplicate definitions
     $actions = CRM_Case_Selector_Search::links();
 
-
     // check is the user has view/edit signer permission
     $permissions = array(CRM_Core_Permission::VIEW);
     if (CRM_Core_Permission::check('access all cases and activities') ||
@@ -808,8 +816,7 @@ AND civicrm_case.status_id != $closedId";
       foreach ($resultFields as $donCare => $field) {
         $casesList[$result->case_id][$field] = $result->$field;
         if ($field == 'contact_type') {
-          $casesList[$result->case_id]['contact_type_icon'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ?
-              $result->contact_sub_type : $result->contact_type
+          $casesList[$result->case_id]['contact_type_icon'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type
           );
           $casesList[$result->case_id]['action'] = CRM_Core_Action::formLink($actions['primaryActions'], $mask,
             array(
@@ -954,13 +961,15 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Get Case roles
    *
-   * @param int $contactID contact id
-   * @param int $caseID case id
+   * @param int $contactID
+   *   Contact id.
+   * @param int $caseID
+   *   Case id.
    * @param int $relationshipID
    *
-   * @return array case role / relationships
+   * @return array
+   *   case role / relationships
    *
-   * @static
    */
   public static function getCaseRoles($contactID, $caseID, $relationshipID = NULL) {
     $query = '
@@ -979,7 +988,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
  LEFT JOIN  civicrm_email ON (civicrm_email.contact_id = civicrm_contact.id )
      WHERE  civicrm_relationship.contact_id_a = %1 AND civicrm_relationship.case_id = %2';
 
-
     $params = array(
       1 => array($contactID, 'Positive'),
       2 => array($caseID, 'Positive'),
@@ -1011,17 +1019,20 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Get Case Activities
    *
-   * @param int $caseID case id
-   * @param array $params posted params
-   * @param int $contactID contact id
+   * @param int $caseID
+   *   Case id.
+   * @param array $params
+   *   Posted params.
+   * @param int $contactID
+   *   Contact id.
    *
    * @param null $context
    * @param int $userID
    * @param null $type
    *
-   * @return array of case activities
+   * @return array
+   *   Array of case activities
    *
-   * @static
    */
   public static function getCaseActivity($caseID, &$params, $contactID, $context = NULL, $userID = NULL, $type = NULL) {
     $values = array();
@@ -1156,7 +1167,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
     //EXIT;
     $dao = CRM_Core_DAO::executeQuery($query, $params);
 
-
     $activityTypes = CRM_Case_PseudoConstant::caseActivityType(FALSE, TRUE);
     $activityStatus = CRM_Core_PseudoConstant::activityStatus();
     $activityPriority = CRM_Core_PseudoConstant::get('CRM_Activity_DAO_Activity', 'priority_id');
@@ -1319,7 +1329,6 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
         }
       }
 
-
       $values[$dao->id]['links'] = $url;
       $values[$dao->id]['class'] = "";
 
@@ -1345,7 +1354,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
       }
 
       if ($allowEdit) {
-        $values[$dao->id]['status'] = '<a class="crm-activity-status crm-activity-status-' . $dao->id . ' ' . $values[$dao->id]['class'] . ' crm-activity-change-status crm-editable-enabled" activity_id=' . $dao->id . ' current_status=' . $dao->status . ' case_id=' . $caseID . ' href="#" title=\'' . $statusTitle . '\'>' . $values[$dao->id]['status'] . '</a>';
+        $values[$dao->id]['status'] = '<div class="crmf-status_id crm-activity-status-' . $dao->id . ' ' . $values[$dao->id]['class'] . ' crm-editable" data-type="select" data-action="create" data-refresh="true">' . $values[$dao->id]['status'] . '</div>';
       }
     }
     $dao->free();
@@ -1356,12 +1365,14 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Get Case Related Contacts
    *
-   * @param int $caseID case id
-   * @param boolean $skipDetails if true include details of contacts
+   * @param int $caseID
+   *   Case id.
+   * @param bool $skipDetails
+   *   If true include details of contacts.
    *
-   * @return array $searchRows array of return properties
+   * @return array
+   *   array of return properties
    *
-   * @static
    */
   public static function getRelatedContacts($caseID, $skipDetails = FALSE) {
     $values = array();
@@ -1404,8 +1415,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    * Send e-mail copy of activity
    *
    * @param int $clientId
-   * @param int $activityId activity Id
-   * @param array $contacts array of related contact
+   * @param int $activityId
+   *   Activity Id.
+   * @param array $contacts
+   *   Array of related contact.
    *
    * @param null $attachments
    * @param int $caseId
@@ -1545,12 +1558,12 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    * Retrieve count of activities having a particular type, and
    * associated with a particular case.
    *
-   * @param int $caseId          ID of the case
-   * @param int $activityTypeId  ID of the activity type
+   * @param int $caseId
+   *   ID of the case.
+   * @param int $activityTypeId
+   *   ID of the activity type.
    *
    * @return array
-   *
-   *
    */
   public static function getCaseActivityCount($caseId, $activityTypeId) {
     $queryParam = array(
@@ -1575,9 +1588,11 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Create an activity for a case via email
    *
-   * @param int $file email sent
+   * @param int $file
+   *   Email sent.
    *
-   * @return array|void $activity object of newly creted activity via email@access public
+   * @return array|void
+   *   $activity object of newly creted activity via email
    */
   public static function recordActivityViaEmail($file) {
     if (!file_exists($file) ||
@@ -1663,14 +1678,15 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Retrieve the scheduled activity type and date
    *
-   * @param  array $cases Array of contact and case id
+   * @param array $cases
+   *   Array of contact and case id.
    *
    * @param string $type
    *
-   * @return array  $activityInfo Array of scheduled activity type and date
+   * @return array
+   *   Array of scheduled activity type and date
    *
    *
-   * @static
    */
   public static function getNextScheduledActivity($cases, $type = 'upcoming') {
     $session = CRM_Core_Session::singleton();
@@ -1706,8 +1722,8 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Combine all the exportable fields from the lower levels object
    *
-   * @return array array of exportable Fields
-   * @static
+   * @return array
+   *   array of exportable Fields
    */
   public static function &exportableFields() {
     if (!self::$_exportableFields) {
@@ -1734,10 +1750,10 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Restore the record that are associated with this case
    *
-   * @param  int $caseId id of the case to restore
+   * @param int $caseId
+   *   Id of the case to restore.
    *
-   * @return true if success.
-   * @static
+   * @return bool
    */
   public static function restoreCase($caseId) {
     //restore activities
@@ -1829,13 +1845,16 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
   /**
    * Get Case ActivitiesDueDates with given criteria.
    *
-   * @param int $caseID case id
-   * @param array $criteriaParams given criteria
-   * @param boolean $latestDate if set newest or oldest date is selceted.
+   * @param int $caseID
+   *   Case id.
+   * @param array $criteriaParams
+   *   Given criteria.
+   * @param bool $latestDate
+   *   If set newest or oldest date is selected.
    *
-   * @return returns case activities due dates
+   * @return array
+   *   case activities due dates
    *
-   * @static
    */
   public static function getCaseActivityDates($caseID, $criteriaParams = array(), $latestDate = FALSE) {
     $values = array();
@@ -1843,7 +1862,7 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
     $where = $groupBy = ' ';
 
     if (!$caseID) {
-      return;
+      return NULL;
     }
 
     if ($latestDate) {
@@ -1881,13 +1900,15 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    * Create activities when Case or Other roles assigned/modified/deleted.
    *
    * @param int $caseId
-   * @param int $relationshipId relationship id
-   * @param int $relContactId case role assignee contactId.
+   * @param int $relationshipId
+   *   Relationship id.
+   * @param int $relContactId
+   *   Case role assignee contactId.
    * @param int $contactId
    *
-   * @return void on success creates activity and case activity
+   * @return void
+   *   on success creates activity and case activity
    *
-   * @static
    */
   public static function createCaseRoleActivity($caseId, $relationshipId, $relContactId = NULL, $contactId = NULL) {
     if (!$caseId || !$relationshipId || empty($relationshipId)) {
@@ -1974,16 +1995,18 @@ SELECT case_status.label AS case_status, status_id, civicrm_case_type.title AS c
    * Get case manger
    * contact which is assigned a case role of case manager.
    *
-   * @param int $caseType case type
-   * @param int $caseId   case id
+   * @param int $caseType
+   *   Case type.
+   * @param int $caseId
+   *   Case id.
    *
-   * @return array $caseManagerContact array of contact on success otherwise empty
+   * @return array
+   *   array of contact on success otherwise empty
    *
-   * @static
    */
   public static function getCaseManagerContact($caseType, $caseId) {
     if (!$caseType || !$caseId) {
-      return;
+      return NULL;
     }
 
     $caseManagerContact = array();
@@ -2016,13 +2039,16 @@ SELECT civicrm_contact.id as casemanager_id,
   }
 
   /**
-   * Get all cases with no end dates
+   * Get all cases with no end dates.
    *
    * @param array $params
    * @param array $excludeCaseIds
    * @param bool $excludeDeleted
    *
-   * @return array of case and related data keyed on case id
+   * @param bool $includeClosed
+   *
+   * @return array
+   *   Case and related data keyed on case id
    */
   public static function getUnclosedCases($params = array(), $excludeCaseIds = array(), $excludeDeleted = TRUE, $includeClosed = FALSE) {
     //params from ajax call.
@@ -2145,11 +2171,12 @@ LEFT JOIN  civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.case
   /**
    * Retrieve cases related to particular contact.
    *
-   * @param int $contactId contact id
-   * @param boolean $excludeDeleted do not include deleted cases.
-   *
-   * @return an array of cases.
+   * @param int $contactId
+   *   Contact id.
+   * @param bool $excludeDeleted
+   *   Do not include deleted cases.
    *
+   * @return array
    */
   public static function getContactCases($contactId, $excludeDeleted = TRUE) {
     $cases = array();
@@ -2185,12 +2212,14 @@ INNER JOIN  civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas
   /**
    * Retrieve related cases for give case.
    *
-   * @param int $mainCaseId     id of main case
-   * @param int $contactId      id of contact
-   * @param boolean $excludeDeleted do not include deleted cases.
-   *
-   * @return an array of related cases.
+   * @param int $mainCaseId
+   *   Id of main case.
+   * @param int $contactId
+   *   Id of contact.
+   * @param bool $excludeDeleted
+   *   Do not include deleted cases.
    *
+   * @return array
    */
   public static function getRelatedCases($mainCaseId, $contactId, $excludeDeleted = TRUE) {
     //FIXME : do check for permissions.
@@ -2297,6 +2326,9 @@ INNER JOIN  civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas
    * @see CRM_Dedupe_Merger::cpTables()
    *
    * TODO: use the 3rd $sqls param to append sql statements rather than executing them here
+   *
+   * @param int $mainContactId
+   * @param int $otherContactId
    */
   public static function mergeContacts($mainContactId, $otherContactId) {
     self::mergeCases($mainContactId, NULL, $otherContactId);
@@ -2307,18 +2339,22 @@ INNER JOIN  civicrm_case_contact ON ( civicrm_case.id = civicrm_case_contact.cas
    * 1. Merge two duplicate contacts cases - follow CRM-5758 rules.
    * 2. Merge two cases of same contact - follow CRM-5598 rules.
    *
-   * @param int $mainContactId contact id of main contact record.
-   * @param int $mainCaseId case id of main case record.
-   * @param int $otherContactId contact id of record which is going to merge.
-   * @param int $otherCaseId case id of record which is going to merge.
+   * @param int $mainContactId
+   *   Contact id of main contact record.
+   * @param int $mainCaseId
+   *   Case id of main case record.
+   * @param int $otherContactId
+   *   Contact id of record which is going to merge.
+   * @param int $otherCaseId
+   *   Case id of record which is going to merge.
    *
    * @param bool $changeClient
    *
-   * @return integer|NULL
-   * @static
+   * @return int|NULL
    */
-  static function mergeCases($mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
-                             $otherCaseId = NULL, $changeClient = FALSE) {
+  public static function mergeCases(
+    $mainContactId, $mainCaseId = NULL, $otherContactId = NULL,
+    $otherCaseId = NULL, $changeClient = FALSE) {
     $moveToTrash = TRUE;
 
     $duplicateContacts = FALSE;
@@ -2655,7 +2691,7 @@ SELECT  id
             1 => $otherCaseId,
             2 => $otherContactDisplayName,
             3 => $mainContactDisplayName,
-            4 => $mainCaseId
+            4 => $mainCaseId,
           )
         );
       }
@@ -2666,7 +2702,7 @@ SELECT  id
             1 => $otherCaseId,
             2 => $otherContactId,
             3 => $mainContactId,
-            4 => $mainCaseId
+            4 => $mainCaseId,
           )
         );
       }
@@ -2724,11 +2760,12 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    * Validate contact permission for
    * edit/view on activity record and build links.
    *
-   * @param array $tplParams       params to be sent to template for sending email.
-   * @param array $activityParams  info of the activity.
+   * @param array $tplParams
+   *   Params to be sent to template for sending email.
+   * @param array $activityParams
+   *   Info of the activity.
    *
    * @return void
-   * @static
    */
   public static function buildPermissionLinks(&$tplParams, $activityParams) {
     $activityTypeId = CRM_Core_DAO::getFieldValue('CRM_Activity_DAO_Activity', $activityParams['source_record_id'],
@@ -2763,14 +2800,18 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    * Validate contact permission for
    * given operation on activity record.
    *
-   * @param int $activityId      activity record id.
-   * @param string $operation       user operation.
-   * @param int $actTypeId       activity type id.
-   * @param int $contactId       contact id/if not pass consider logged in
-   * @param boolean $checkComponent  do we need to check component enabled.
+   * @param int $activityId
+   *   Activity record id.
+   * @param string $operation
+   *   User operation.
+   * @param int $actTypeId
+   *   Activity type id.
+   * @param int $contactId
+   *   Contact id/if not pass consider logged in.
+   * @param bool $checkComponent
+   *   Do we need to check component enabled.
    *
-   * @return boolean $allow  true/false
-   * @static
+   * @return bool
    */
   public static function checkPermission($activityId, $operation, $actTypeId = NULL, $contactId = NULL, $checkComponent = TRUE) {
     $allow = FALSE;
@@ -2852,7 +2893,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
           //need to check activity object specific.
           if (in_array($operation, array(
             'view',
-            'edit'
+            'edit',
           ))
           ) {
             //do we have supper permission.
@@ -2938,7 +2979,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
         'Link Cases',
         'Assign Case Role',
         'Email',
-        'Inbound Email'
+        'Inbound Email',
       );
 
       //do not allow to delete these activities, CRM-4543
@@ -2956,7 +2997,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
         'Reassigned Case',
         'Merge Case',
         'Link Cases',
-        'Assign Case Role'
+        'Assign Case Role',
       );
 
       if (in_array($actTypeName, $singletonNames)) {
@@ -3030,7 +3071,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    * Verify user has permission to access a case
    *
    * @param int $caseId
-   * @param bool $denyClosed set TRUE if one wants closed cases to be treated as inaccessible
+   * @param bool $denyClosed
+   *   Set TRUE if one wants closed cases to be treated as inaccessible.
    *
    * @return bool
    */
@@ -3077,9 +3119,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
   /**
    * Check whether activity is a case Activity
    *
-   * @param  int $activityID   activity id
+   * @param int $activityID
+   *   Activity id.
    *
-   * @return boolean  $isCaseActivity true/false
+   * @return bool
    */
   public static function isCaseActivity($activityID) {
     $isCaseActivity = FALSE;
@@ -3097,8 +3140,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
   /**
    * Get all the case type ids currently in use
    *
-   *
-   * @return array $caseTypeIds
+   * @return array
    */
   public static function getUsedCaseType() {
     static $caseTypeIds;
@@ -3122,8 +3164,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
   /**
    * Get all the case status ids currently in use
    *
-   *
-   * @return array $caseStatusIds
+   * @return array
    */
   public static function getUsedCaseStatuses() {
     static $caseStatusIds;
@@ -3143,6 +3184,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
 
   /**
    * Get all the encounter medium ids currently in use
+   *
    * @return array
    */
   public static function getUsedEncounterMediums() {
@@ -3166,7 +3208,7 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    *
    * @param int $contactId
    *
-   * @return array $configured
+   * @return array
    */
   public static function isCaseConfigured($contactId = NULL) {
     $configured = array_fill_keys(array('configured', 'allowToAddNewCase', 'redirectToCaseAdmin'), FALSE);
@@ -3213,6 +3255,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
 
   /**
    * Used during case component enablement and during ugprade
+   *
+   * @return bool
    */
   public static function createCaseViews() {
     $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
@@ -3247,6 +3291,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
 
   /**
    * Helper function, also used by the upgrade in case of error
+   *
+   * @param string $section
+   *
+   * @return string
    */
   public static function createCaseViewsQuery($section = 'upcoming') {
     $sql = "";
@@ -3277,8 +3325,10 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
   /**
    * Add/copy relationships, when new client is added for a case
    *
-   * @param int $caseId case id
-   * @param int $contactId contact id / new client id
+   * @param int $caseId
+   *   Case id.
+   * @param int $contactId
+   *   Contact id / new client id.
    *
    * @return void
    */
@@ -3319,8 +3369,8 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    *
    * @param int $caseId
    *
-   * @return array $clients associated array with client ids
-   * @static
+   * @return array
+   *   associated array with client ids
    */
   public static function getCaseClients($caseId) {
     $clients = array();
@@ -3339,11 +3389,13 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
    * Get options for a given case field.
    * @see CRM_Core_DAO::buildOptions
    *
-   * @param String $fieldName
-   * @param String $context : @see CRM_Core_DAO::buildOptionsContext
-   * @param Array $props : whatever is known about this dao object
+   * @param string $fieldName
+   * @param string $context
+   * @see CRM_Core_DAO::buildOptionsContext
+   * @param array $props
+   *   Whatever is known about this dao object.
    *
-   * @return Array|bool
+   * @return array|bool
    */
   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
     $className = __CLASS__;
@@ -3356,4 +3408,5 @@ WHERE id IN (' . implode(',', $copiedActivityIds) . ')';
     }
     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
   }
+
 }