getfields api - ensure 'name' property is set for every field

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

diff --git a/api/v3/Entity.php b/api/v3/Entity.php
index e0c30dbf80947f72b677e58f76899388f57578ca..ff3bb42511e40e6abb431a9c43c02a74c75a0565 100644 (file)
--- a/api/v3/Entity.php
+++ b/api/v3/Entity.php
@@ -1,25 +1,64 @@
 <?php
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Get list of deprecated entities.
+ *
+ * @deprecated api notice
+ *
+ * @param array $entities
+ *
+ * @return array
+ *   Array of deprecated api entities
+ */
+function _civicrm_api3_entity_deprecation($entities) {
+  $deprecated = array();
+  if (!empty($entities['values'])) {
+    foreach ($entities['values'] as $entity) {
+      if (is_string(_civicrm_api3_deprecation_check($entity))) {
+        $deprecated[] = $entity;
+      }
+    }
+  }
+  return $deprecated;
+}
+
+/**
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_entity_create($params) {
   return civicrm_api3_create_error("API (Entity, Create) does not exist Creating a new entity means modifying the source code of civiCRM.");
 }
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_entity_delete($params) {
   return civicrm_api3_create_error("API (Entity, Delete) does not exist Deleting an entity means modifying the source code of civiCRM.");
 }
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
+ * @param array $params
+ *
+ * @return array
  */
 function civicrm_api3_entity_getfields($params) {
   // we return an empty array so it makes it easier to write generic getdefaults / required tests
   // without putting an exception in for entity
   return civicrm_api3_create_success(array());
 }
-