X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FCaseType.php;h=af0d9b7e5b6706a35b91927d64fe217fd10fcdf1;hb=4f87ec96e8ba594ad1705a8806999bd0bc976bb0;hp=139b852d3e6754e93ee9caea2d33707ae4e71ecc;hpb=a922142c067998cb0ffb4cbc95a71aa370ffdc88;p=civicrm-core.git

diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php
index 139b852d3e..af0d9b7e5b 100644
--- a/api/v3/CaseType.php
+++ b/api/v3/CaseType.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-2015                                |
   +--------------------------------------------------------------------+
   | This file is a part of CiviCRM.                                    |
   |                                                                    |
@@ -23,43 +23,35 @@
   | GNU Affero General Public License or the licensing of CiviCRM,     |
   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
   +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 Case functions
- * Developed by woolman.org
+ * This api exposes CiviCRM Case.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Case
- * @copyright CiviCRM LLC (c) 2004-2014
- *
  */
 
 /**
- * create or update case type
+ * Create or update case type.
  *
  * @param array $params
  *   Input parameters.
  *
- * Allowed @params array keys are:
- * {@getfields case_type_create}
- *
  * @throws API_Exception
  * @return array
  *   API result array
- *
- * @static void
- * @access public
  */
 function civicrm_api3_case_type_create($params) {
   civicrm_api3_verify_mandatory($params, _civicrm_api3_get_DAO(__FUNCTION__));
-  unset($params['is_forkable']); // computed property
-  unset($params['is_forked']); // computed property
+  // Computed properties.
+  unset($params['is_forkable']);
+  unset($params['is_forked']);
 
   if (!array_key_exists('is_active', $params) && empty($params['id'])) {
     $params['is_active'] = TRUE;
   }
-  if (!empty($params['id']) // this is an existing case-type
+  // This is an existing case-type.
+  if (!empty($params['id'])
     && !CRM_Case_BAO_CaseType::isForked($params['id']) // which is not yet forked
     && !CRM_Case_BAO_CaseType::isForkable($params['id']) // for which new forks are prohibited
   ) {
@@ -70,13 +62,12 @@ function civicrm_api3_case_type_create($params) {
 }
 
 /**
- * retrieve case types
+ * Retrieve case types.
  *
  * @param array $params
  *
  * @return array
  *   case types keyed by id
- * @access public
  */
 function civicrm_api3_case_type_get($params) {
   if (!empty($params['options']) && !empty($params['options']['is_count'])) {
@@ -88,10 +79,12 @@ function civicrm_api3_case_type_get($params) {
 }
 
 /**
- * format definition
+ * Format definition.
+ *
+ * @param array $result
  *
- * @param $caseTypes
- * @return mixed
+ * @return array
+ * @throws \CRM_Core_Exception
  */
 function _civicrm_api3_case_type_get_formatResult(&$result) {
   foreach ($result['values'] as $key => $caseType) {
@@ -110,16 +103,13 @@ function _civicrm_api3_case_type_get_formatResult(&$result) {
 }
 
 /**
- * Function to delete case type
+ * Function to delete case type.
  *
  * @param array $params
- *   Array including id of case_type to delete.
-
+ *   Array including id of CaseType to delete.
+ *
  * @return array
  *   API result array
- *
- * @access public
- *
  */
 function civicrm_api3_case_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);