<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | 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 |
+--------------------------------------------------------------------+
-*/
+ */
namespace Civi\CCase;
+/**
+ * Class Analyzer
+ *
+ * @package Civi\CCase
+ */
class Analyzer {
/**
* @var int
*/
private $indices;
+ /**
+ * @param $caseId
+ */
public function __construct($caseId) {
$this->caseId = $caseId;
$this->flush();
/**
* Determine if case includes an activity of given type/status
*
- * @param string $type eg "Phone Call", "Interview Prospect", "Background Check"
- * @param string $status eg "Scheduled", "Completed"
+ * @param string $type
+ * Eg "Phone Call", "Interview Prospect", "Background Check".
+ * @param string $status
+ * Eg "Scheduled", "Completed".
* @return bool
*/
public function hasActivity($type, $status = NULL) {
$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'];
}
/**
- * 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)
+ * @return array
+ * list of activity records (api/v3 format)
*/
public function getActivities() {
if ($this->activities === NULL) {
}
/**
- * Get a single activity record by type
+ * Get a single activity record by type.
*
* @param string $type
* @throws \Civi\CCase\Exception\MultipleActivityException
/**
* Get a list of all activities in the case (indexed by some property/properties)
*
- * @param array $keys list of properties by which to index activities
- * @return array list of activity records (api/v3 format), indexed by $keys
+ * @param array $keys
+ * List of properties by which to index activities.
+ * @return array
+ * list of activity records (api/v3 format), indexed by $keys
*/
public function getActivityIndex($keys) {
$key = implode(";", $keys);
}
/**
- * Flush any cached information
+ * Flush any cached information.
*
* @return void
*/
$this->activities = NULL;
$this->indices = array();
}
+
}