You are here

Home » API reference » Drupal 9 » hal.module

function hal_help in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/hal/hal.module \hal_help()

Implements hook_help().

File

core/modules/hal/hal.module, line 13
Adds support for serializing entities to Hypertext Application Language.

Code

function hal_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.hal':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $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>';
      $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>';
      $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>';
      return $output;
  }
}