function services_help in Services 6.2

Same name and namespace in other branches

1. 5 services.module \services_help()
2. 6.3 services.module \services_help()
3. 6 services.module \services_help()
4. 7.3 services.module \services_help()
5. 7 services.module \services_help()

Implementation of hook_help().

File

./services.module, line 11

Provides a generic but powerful API for exposing web services.

Code

function services_help($path, $arg) {
  switch ($path) {
    case 'admin/help#services':
      $output = '<p>' . t('Services is a standardized API for Drupal that allows you to create "services", or a collection of methods, intended for consumption by remote applications. Several "servers", or protocols, provide different ways to call these methods from remote site. It works similar to the existing XMLRPC capabilities of Drupal, but provides additional functionality like:') . '</p>';
      $output .= '<ul><li>' . t('Pluggable "server" modules allowing for protocols other than XMLRPC (like SOAP, REST, JSON.)') . '</li>';
      $output .= '<li>' . t('Pluggable "service" modules allowing developers to add additional remote services.') . '</li>';
      $output .= '<li>' . t('Pluggable "authentication" modules allowing developers to authenticate as they wish (Drupal sessions, API keys, oAuth, etc.)') . '</li>';
      $output .= '<li>' . t('A service browser and method tester.') . '</li>';
      $output .= '<li>' . t('A number of included service modules which interact with existing Drupal modules like node, taxonomy, user, views, and system.') . '</li></ul>';
      $output .= '<p>' . t('You can enable service modules on the module installation page. Visit the Services page linked below to configure and test your services.') . '</p>';
      $output .= '<p>' . t('Visit the <a href="@handbook_url">Services Handbook</a> for help and information.', array(
        '@handbook_url' => 'http://drupal.org/node/109782',
      )) . '</p>';
      return $output;
    case 'admin/build/services':
    case 'admin/build/services/browse':
      $output = '<p>' . t('Services are collections of methods available to remote applications. They are defined in modules, and may be accessed in a number of ways through server modules. Visit the <a href="@handbook_url">Services Handbook</a> for help and information.', array(
        '@handbook_url' => 'http://drupal.org/node/109782',
      )) . '</p>';
      $output .= '<p>' . t('All enabled services and methods are shown. Click on any method to view information or test.') . '</p>';
      return $output;
    case 'admin/build/services/keys':
      return t('An API key is required to allow an application to access Drupal remotely.');
  }
}