Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: full-nodes
Fetching contributors…

Cannot retrieve contributors at this time

235 lines (231 sloc) 8.987 kB
<?php
/**
* @file
* Hooks provided by Services for the definition of new services.
*/
/**
* @addtogroup hooks
*/
/**
* Defines function signatures for resources available to services.
*
* Functionally this is very similar to the way hook_menu() works, and in many
* ways Services can be seen as an abstraction layer on top of hook_menu().
*
* @return
* An associative array which defines available resources.
*
* The associative array which defines services has seven possible top
* level keys:
*
* - create
* - retrieve
* - update
* - delete
* - actions
* - targeted_actions
* - relationships
*
*
* The first four (the CRUD functions) define the indvidual service
* callbacks for each function. However 'actions' and 'targeted_actions'
* can contain multiple callbacks.
*
* For those familiar with Services 2.x, these callbacks are created
* similarly, but the keys have changed around a bit. The following keys
* are used to describe a callback.
*
* - help: Text describing what this callback does.
* - callback: The name of a function to call when this resource is
* requested.
* - access callback: The name of a function to call to check whether
* the requesting user has permission to access this resource. If not
* specified, this defaults to 'user_access'.
* - access arguments: The arguments to pass to the access callback.
* - access arguments append: A boolean indicating whether the resource's
* arguments should be appended to the access arguments. This can be useful
* in situations where an access callback is specific to the particular
* item ('edit all nodes' vs 'edit my nodes'). Defaults to FALSE.
* - args: an array describing the arguments which should be passed to this
* resource when it is called. Each element in the array is an associative
* array containing the following keys:
*
* - name: The name of this argument.
* - type: The data type of this argument (int, string, array)
* - description: Text describing this argument's usage.
* - optional: A boolean indicating whether or not this argument is optional.
* - source: Where this argument should be retrieved from. This can be
* 'data' (indicating the POST data), 'param' (indicating the query
* string) or 'path' (indicating the url path). In the case of path,
* an additional parameter must be passed indicating the index to be used.
* - default value: this is a value that will be passed to the method for this particular argument if no argument value is passed
*/
function hook_services_resources() {
$node_resource = array(
'node' => array(
'retrieve' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'callback' => '_node_resource_retrieve',
'args' => array(
array(
'name' => 'nid',
'optional' => FALSE,
'source' => array('path' => 0),
'type' => 'int',
'description' => 'The nid of the node to get',
),
),
'access callback' => '_node_resource_access',
'access arguments' => array('view'),
'access arguments append' => TRUE,
),
'create' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'callback' => '_node_resource_create',
'args' => array(
array(
'name' => 'node',
'optional' => FALSE,
'source' => 'data',
'description' => 'The node data to create',
'type' => 'array',
),
),
'access callback' => '_node_resource_access',
'access arguments' => array('create'),
'access arguments append' => TRUE,
),
'update' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'callback' => '_node_resource_update',
'args' => array(
array(
'name' => 'nid',
'optional' => FALSE,
'source' => array('path' => 0),
'type' => 'int',
'description' => 'The nid of the node to get',
),
array(
'name' => 'node',
'optional' => FALSE,
'source' => 'data',
'description' => 'The node data to update',
'type' => 'array',
),
),
'access callback' => '_node_resource_access',
'access arguments' => array('update'),
'access arguments append' => TRUE,
),
'delete' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'callback' => '_node_resource_delete',
'args' => array(
array(
'name' => 'nid',
'optional' => FALSE,
'source' => array('path' => 0),
'type' => 'int',
),
),
'access callback' => '_node_resource_access',
'access arguments' => array('delete'),
'access arguments append' => TRUE,
),
'index' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'callback' => '_node_resource_index',
'args' => array(
array(
'name' => 'page',
'optional' => TRUE,
'type' => 'int',
'description' => 'The zero-based index of the page to get, defaults to 0.',
'default value' => 0,
'source' => array('param' => 'page'),
),
array(
'name' => 'fields',
'optional' => TRUE,
'type' => 'string',
'description' => 'The fields to get.',
'default value' => '*',
'source' => array('param' => 'fields'),
),
array(
'name' => 'parameters',
'optional' => TRUE,
'type' => 'array',
'description' => 'Parameters array',
'default value' => array(),
'source' => array('param' => 'parameters'),
),
),
'access arguments' => array('access content'),
),
'relationships' => array(
'files' => array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'help' => t('This method returns files associated with a node.'),
'access callback' => '_node_resource_access',
'access arguments' => array('view'),
'access arguments append' => TRUE,
'callback' => '_node_resource_load_node_files',
'args' => array(
array(
'name' => 'nid',
'optional' => FALSE,
'source' => array('path' => 0),
'type' => 'int',
'description' => 'The nid of the node whose files we are getting',
),
array(
'name' => 'file_contents',
'type' => 'int',
'description' => t('To return file contents or not.'),
'source' => array('path' => 2),
'optional' => TRUE,
'default value' => TRUE,
),
),
),
),
),
);
if (module_exists('comment')) {
$comments = array(
'file' => array('type' => 'inc', 'module' => 'services', 'name' => 'resources/node_resource'),
'help' => t('This method returns the number of new comments on a given node.'),
'access callback' => 'user_access',
'access arguments' => array('access comments'),
'access arguments append' => FALSE,
'callback' => '_node_resource_load_node_comments',
'args' => array(
array(
'name' => 'nid',
'type' => 'int',
'description' => t('The node id to load comments for.'),
'source' => array('path' => 0),
'optional' => FALSE,
),
array(
'name' => 'count',
'type' => 'int',
'description' => t('Number of comments to load.'),
'source' => array('param' => 'count'),
'optional' => TRUE,
),
array(
'name' => 'offset',
'type' => 'int',
'description' => t('If count is set to non-zero value, you can pass also non-zero value for start. For example to get comments from 5 to 15, pass count=10 and start=5.'),
'source' => array('param' => 'offset'),
'optional' => TRUE,
),
),
);
$node_resource['node']['relationships']['comments'] = $comments;
}
return $node_resource;
}
Jump to Line
Something went wrong with that request. Please try again.