www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/hal/hal.module

   1 <?php
   2
   3 /**
   4  * @file
   5  * Adds support for serializing entities to Hypertext Application Language.
   6  */
   7
   8 use Drupal\Core\Routing\RouteMatchInterface;
   9
  10 /**
  11  * Implements hook_help().
  12  */
  13 function hal_help($route_name, RouteMatchInterface $route_match) {
  14   switch ($route_name) {
  15     case 'help.page.hal':
  16       $output = '';
  17       $output .= '<h3>' . t('About') . '</h3>';
  18       $output .= '<p>' . t('<a href=":hal_spec">Hypertext Application Language (HAL)</a> is a format that supports the linking required for hypermedia APIs.', [':hal_spec' => 'http://stateless.co/hal_specification.html']) . '</p>';
  19       $output .= '<p>' . t('Hypermedia APIs are a style of Web API that uses URIs to identify resources and the <a href="http://wikipedia.org/wiki/Link_relation">link relations</a> between them, enabling API consumers to follow links to discover API functionality.') . '</p>';
  20       $output .= '<p>' . t('This module adds support for serializing entities (such as content items, taxonomy terms, etc.) to the JSON version of HAL. For more information, see the <a href=":hal_do">online documentation for the HAL module</a>.', [':hal_do' => 'https://www.drupal.org/documentation/modules/hal']) . '</p>';
  21       return $output;
  22   }
  23 }