Index: services.install =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/services/Attic/services.install,v retrieving revision 1.3.2.21.2.1 diff -u -p -r1.3.2.21.2.1 services.install --- services.install 3 Dec 2009 05:52:08 -0000 1.3.2.21.2.1 +++ services.install 4 Dec 2009 22:01:47 -0000 @@ -2,7 +2,6 @@ // $Id: services.install,v 1.3.2.21.2.1 2009/12/03 05:52:08 heyrocker Exp $ /** - * @author Services Dev Team * @file * Install, uninstall and update the module. */ Index: services.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/services/Attic/services.module,v retrieving revision 1.8.2.88.2.11 diff -u -p -r1.8.2.88.2.11 services.module --- services.module 3 Dec 2009 05:52:08 -0000 1.8.2.88.2.11 +++ services.module 4 Dec 2009 22:01:53 -0000 @@ -2,9 +2,8 @@ // $Id: services.module,v 1.8.2.88.2.11 2009/12/03 05:52:08 heyrocker Exp $ /** - * @author Services Dev Team * @file - * Provides a generic by powerful API for web services. + * Provides a generic but powerful API for exposing web services. */ /** @@ -159,6 +158,13 @@ function services_crossdomain_xml() { services_xml_output($output); } +/** + * Helper function for sending xml output. This method outputs a xml + * processing instruction and the necessary headers and then exits. + * + * @param string $xml + * @return void + */ function services_xml_output($xml) { $xml = ''."\n". $xml; header('Connection: close'); @@ -169,6 +175,15 @@ function services_xml_output($xml) { exit; } +/** + * Sets information about which server implementation that is used for the + * call. + * + * @param string $module + * The server module that's handling the call. + * @return object + * Server info object. + */ function services_set_server_info($module) { $server_info = new stdClass(); $server_info->module = $module; @@ -176,6 +191,15 @@ function services_set_server_info($modul return services_get_server_info($server_info); } +/** + * Returns or sets the server info object. + * + * @param object $server_info + * Optional. Pass a object to set the server info object. Omit to just + * retrieve the server info. + * @return object + * Server info object. + */ function services_get_server_info($server_info = NULL) { static $info; if (!$info && $server_info) { @@ -184,9 +208,18 @@ function services_get_server_info($serve return $info; } -/** - * Prepare an error message for returning to the server. - */ + /** + * Prepare an error message for returning to the server. + * + * @param string $message + * The error message. + * @param int $code + * Optional. A error code, these should map as closely to the applicable + * http error codes as closely as possible. + * @param Exception $exception + * Optional. The exception was thrown (if any) when the error occured. + * @return mixed + */ function services_error($message, $code = 0, $exception = NULL) { $server_info = services_get_server_info(); @@ -235,6 +268,19 @@ function services_auth_info($property = return $info[$module]; } +/** + * Invokes a method for the configured authentication module. + * + * @param string $method + * The method to call. + * @param mixed $arg1 + * Optional. First argument. + * @param mixed $arg2 + * Optional. Second argument. + * @param mixed $arg3 + * Optional. Third argument. + * @return mixed + */ function services_auth_invoke($method, &$arg1 = NULL, &$arg2 = NULL, &$arg3 = NULL) { $module = variable_get('services_auth_module', ''); // Get information about the current auth module @@ -256,6 +302,21 @@ function services_auth_invoke($method, & } } +/** + * Invokes a method for the given authentication module. + * + * @param string $module + * The authentication module to call the method for. + * @param string $method + * The method to call. + * @param mixed $arg1 + * Optional. First argument. + * @param mixed $arg2 + * Optional. Second argument. + * @param mixed $arg3 + * Optional. Third argument. + * @return mixed + */ function services_auth_invoke_custom($module, $method, &$arg1 = NULL, &$arg2 = NULL, &$arg3 = NULL) { // Get information about the auth module $func = services_auth_info($method, $module); @@ -277,7 +338,16 @@ function services_auth_invoke_custom($mo } /** - * This is the magic function through which all remote method calls must pass. + * Invokes a services method. + * + * @param mixed $method_name + * The method name or a method definition array. + * @param array $args + * Optional. An array containing arguments for the method. These arguments are not + * matched by name but by position. + * @param bool $browsing + * Optional. Whether the call was made by the services browser or not. + * @return mixed */ function services_method_call($method_name, $args = array(), $browsing = FALSE) { if (is_array($method_name) && isset($method_name['callback'])) { @@ -441,6 +511,9 @@ function services_get_all_resources($inc } } +/** + * Implementation of hook_form_alter(). + */ function services_form_alter(&$form, $form_state, $form_id) { if ($form_id == 'system_modules') { // Add our own submit hook to clear cache @@ -448,11 +521,26 @@ function services_form_alter(&$form, $fo } } +/** + * Submit handler for the system_modules form that clears the services cache. + */ function services_system_modules_submit($form, &$form_state) { // Reset services cache services_get_all(TRUE, TRUE); } +/** + * Processes the passed resources and adds all the controllers to the + * controller array. + * + * @param array $resources + * The resources that should be processed. + * @param string $controllers + * An array (passed by reference) that will be populated with the controllers + * of the passed resources. + * @param string $path + * Optional. Deprecated. + */ function services_process_resources(&$resources, &$controllers, $path=array()) { foreach ($resources as $name => &$resource) { if (drupal_substr($name, 0, 1) != '#') { @@ -461,6 +549,19 @@ function services_process_resources(&$re } } +/** + * Processes a single resource and adds it's controllers to the controllers + * array. + * + * @param string $name + * The name of the resource. + * @param array $resource + * The resource definition. + * @param array $controllers + * An array (passed by reference) that will be populated with the controllers + * of the passed resources. + * @return void + */ function _services_process_resource($name, &$resource, &$controllers) { $path = join($name, '/'); $resource['name'] = $path; @@ -515,6 +616,13 @@ function _services_process_resource($nam } } +/** + * Should be removed. This code doesn't seem to be used anywhere. + * + * @param string $perm + * The permission to check for. + * @return bool + */ function services_delegate_access($perm) { return services_auth_invoke('delegate_access', $perm); } @@ -602,6 +710,14 @@ function services_method_load($method) { return isset($method) ? $method : FALSE; } +/** + * Get's the definition of a method. + * + * @param string $method_name + * The name of the method to get the definition for. + * @return array + * The method definition. + */ function services_method_get($method_name) { static $method_cache; if (!isset($method_cache[$method_name])) { @@ -617,6 +733,10 @@ function services_method_get($method_nam /** * Cleanup function to remove unnecessary hashes from service definitions. + * + * @param array $array + * A service definition or an array of service definitions. + * @return void */ function services_strip_hashes(&$array) { foreach ($array as $key => $value) { @@ -631,7 +751,15 @@ function services_strip_hashes(&$array) } /** - * Make any changes we might want to make to node. + * Creates an object that only contains the specified attributes from the node + * object. + * + * @param object $node + * The node to get the attributes. + * @param array $fields + * An array containing the names of the attributes to get. + * @return object + * An object with the specified attributes. */ function services_node_load($node, $fields = array()) { if (!isset($node->nid)) { Index: services.resource-translation.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/services/Attic/services.resource-translation.inc,v retrieving revision 1.1.2.4 diff -u -p -r1.1.2.4 services.resource-translation.inc --- services.resource-translation.inc 3 Dec 2009 05:52:08 -0000 1.1.2.4 +++ services.resource-translation.inc 4 Dec 2009 22:01:53 -0000 @@ -2,11 +2,19 @@ // $Id: services.resource-translation.inc,v 1.1.2.4 2009/12/03 05:52:08 heyrocker Exp $ /** - * @author Services Dev Team * @file - * Resource translation functions for Services. + * Contains the necessary functionality for translating resources to services + * methods and vice versa. */ +/** + * Returns the given resource as a set of services methods. + * + * @param array $resource + * A resource definition. + * @return array + * An array of services method definitions + */ function _services_resource_as_services($resource) { static $controllers = array( 'create' => 'create', @@ -45,6 +53,10 @@ function _services_resource_as_services( return $methods; } +/** + * Helper function for _services_resource_as_services() that turns a resource + * controller into a service method. + */ function _services_resource_controller_as_service($resource, $name, $controller, $file) { $method = array_merge($controller, array( 'method' => $resource .'_resource.'. $name, @@ -57,6 +69,16 @@ function _services_resource_controller_a return $method; } +/** + * Turns an array of services methods into resources where all methods are + * added as actions. A 'menu.get'-method would be added as a 'get'-action on + * the resource 'service_menu'. + * + * @param array $services + * An array of service methods. + * @return array + * An array of resource definitions. + */ function _services_services_as_resources($services) { $resources = array(); Index: services_admin_browse.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/services/Attic/services_admin_browse.inc,v retrieving revision 1.5.2.45.2.3 diff -u -p -r1.5.2.45.2.3 services_admin_browse.inc --- services_admin_browse.inc 4 Nov 2009 21:43:25 -0000 1.5.2.45.2.3 +++ services_admin_browse.inc 4 Dec 2009 22:01:55 -0000 @@ -1,7 +1,6 @@