api/v3/Entity.php

   1 <?php
   2
   3 /**
   4  * Get list of deprecated entities.
   5  *
   6  * This is called by the api wrapper when returning the result of api.Entity.get.
   7  *
   8  * @param array $entities
   9  *
  10  * @return array
  11  *   Array of deprecated api entities
  12  */
  13 function _civicrm_api3_entity_deprecation($entities) {
  14   $deprecated = [];
  15   if (!empty($entities['values'])) {
  16     foreach ($entities['values'] as $entity) {
  17       if (is_string(_civicrm_api3_deprecation_check($entity))) {
  18         $deprecated[] = $entity;
  19       }
  20     }
  21   }
  22   return $deprecated;
  23 }
  24
  25 /**
  26  * Placeholder function.
  27  *
  28  * This should never be called, as it doesn't have any meaning.
  29  *
  30  * @param array $params
  31  *
  32  * @return array
  33  */
  34 function civicrm_api3_entity_create($params) {
  35   return civicrm_api3_create_error("API (Entity, Create) does not exist Creating a new entity means modifying the source code of civiCRM.");
  36 }
  37
  38 /**
  39  * Placeholder function.
  40  *
  41  * This should never be called, as it doesn't have any meaning.
  42  *
  43  * @param array $params
  44  *
  45  * @return array
  46  */
  47 function civicrm_api3_entity_delete($params) {
  48   return civicrm_api3_create_error("API (Entity, Delete) does not exist Deleting an entity means modifying the source code of civiCRM.");
  49 }
  50
  51 /**
  52  * Placeholder function.
  53  *
  54  * This should never be called, as it doesn't have any meaning.
  55  *
  56  * @param array $params
  57  *
  58  * @return array
  59  */
  60 function civicrm_api3_entity_getfields($params) {
  61   // we return an empty array so it makes it easier to write generic getdefaults / required tests
  62   // without putting an exception in for entity
  63   return civicrm_api3_create_success([]);
  64 }