Merge pull request #4865 from eileenmcnaughton/my-first-factory

[civicrm-core.git] / api / v3 / CustomValue.php

diff --git a/api/v3/CustomValue.php b/api/v3/CustomValue.php
index a2d46c8ff484f433c4786c69faa8733a04b62063..11433166e39bcc348459d2247744a3f18a913d78 100644 (file)
--- a/api/v3/CustomValue.php
+++ b/api/v3/CustomValue.php
@@ -2,7 +2,7 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -45,7 +45,8 @@
  * Sets custom values for an entity.
  *
  *
- * @param $params  expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID
+ * @param $params
+ *   Expected keys are in format custom_fieldID:recordID or custom_groupName:fieldName:recordID.
  * for example:
  * // entity ID. You do not need to specify entity type, we figure it out based on the fields you're using
  * 'entity_id' => 123,
@@ -117,7 +118,8 @@ function civicrm_api3_custom_value_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_custom_value_create_spec(&$params) {
   $params['entity_id']['api.required'] = 1;
@@ -127,7 +129,8 @@ function _civicrm_api3_custom_value_create_spec(&$params) {
 /**
  * Use this API to get existing custom values for an entity.
  *
- * @param $params  array specifying the entity_id
+ * @param $params
+ *   Array specifying the entity_id.
  * Optionally include entity_type param, i.e. 'entity_type' => 'Activity'
  * If no entity_type is supplied, it will be determined based on the fields you request.
  * If no entity_type is supplied and no fields are specified, 'Contact' will be assumed.
@@ -205,7 +208,7 @@ function civicrm_api3_custom_value_get($params) {
         $n = 0;
         $id = $fieldNumber;
       }
-      else{
+      else {
         $n = $idArray[2];
         $id = $fieldNumber . "." . $idArray[2];
       }
@@ -232,8 +235,10 @@ function civicrm_api3_custom_value_get($params) {
  * Adjust Metadata for Get action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_custom_value_get_spec(&$params) {
   $params['entity_id']['api.required'] = 1;
+  $params['entity_id']['title'] = 'Entity ID';
 }