content_sync-8.x-2.x-dev/src/ContentSyncHelpManagerInterface.php

<?php

namespace Drupal\content_sync;

use Drupal\Core\Routing\RouteMatchInterface;

/**
 * Defines an interface for help classes.
 */
interface ContentSyncHelpManagerInterface {

  /**
   * Get help.
   *
   * @param string|null $id
   *   (optional) Help id.
   *
   * @return array|mixed
   *   A single help item or all help.
   */
  public function getHelp($id = NULL);

  /**
   * Build help for specific route.
   *
   * @param string $route_name
   *   The route for which to find help.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match object from which to find help.
   *
   * @return array
   *   An render array containing help for specific route.
   */
  public function buildHelp($route_name, RouteMatchInterface $route_match);

  /**
   * Build help (aka 'How can we help you?') menu (dropbutton) element.
   *
   * @return array
   *   An render array containing about (aka 'How can we help you?') operations
   *   (dropbutton) element.
   */
  public function buildHelpMenu();

  /**
   * Build the main help page for the Content Sync module.
   *
   * @return array
   *   An render array containing help for the Content Sync module.
   */
  public function buildIndex();

  /**
   * Build the about section.
   *
   * @return array
   *   An render array containing the about section.
   */
  public function buildAbout();

  /**
   * Build the uses section.
   *
   * @param bool $docs
   *   Set to TRUE to build exportable HTML documentation.
   *
   * @return array
   *   An render array containing the uses section.
   */
  public function buildUses($docs = FALSE);

}