services_entity.api.php in Services Entity API 7.2

Hooks provided by Services Entity for the definition of Resource Controllers.

File

services_entity.api.php

<?php

/**
 * @file
 * Hooks provided by Services Entity for the definition of Resource Controllers.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Defines Services Entity resource plugins.
 *
 * @return
 *   An associative array with the following keys:
 *   - 'title': The display name of the controller.
 *	 - 'description': A short description of the controller.
 *   - 'class': The class name of the controller. This should be in a separate
 *     file included in the module .info file.
 *
 * @see hook_services_entity_resource_info_alter()
 */
function hook_services_entity_resource_info() {
  $result = array();
  $result['generic'] = array(
    'title' => 'Generic Entity Processor',
    'description' => 'Acts as a generic wrapper for entities. Data structures are exactly what they are in Drupal.',
    'class' => 'ServicesEntityResourceController',
  );
  return $result;
}

/**
 * Allow modules to alter definitions of Services Entity resource plugins.
 *
 * @param $info
 *  The info array from hook_services_entity_resource_info().
 */
function hook_services_entity_resource_info_alter(&$info) {
}

Functions

Name	Description
hook_services_entity_resource_info	Defines Services Entity resource plugins.
hook_services_entity_resource_info_alter	Allow modules to alter definitions of Services Entity resource plugins.