You are here

Home » API reference » Services Menu 2.x » ServicesMenuResource.php

class ServicesMenuResource in Services Menu 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/rest/resource/ServicesMenuResource.php \Drupal\services_menu\Plugin\rest\resource\ServicesMenuResource

Provides a service resource for menus.

Plugin annotation


@RestResource(
  id = "services_menu",
  label = @Translation("Services for menus."),
  uri_paths = {
    "canonical" = "/services/menu/{menu}"
  }
)

Hierarchy

Expanded class hierarchy of ServicesMenuResource

File

src/Plugin/rest/resource/ServicesMenuResource.php, line 24

Namespace

Drupal\services_menu\Plugin\rest\resource
View source 
class ServicesMenuResource extends ResourceBase {

  /**
   * The menu tree.
   *
   * @var \Drupal\Core\Menu\MenuLinkTreeInterface
   */
  protected $menuTree;

  /**
   * The url generator service.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * Constructs a Drupal\rest\Plugin\ResourceBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param array $serializer_formats
   *   The available serialization formats.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Menu\MenuLinkTreeInterface $menuTree
   *   The menu tree.
   * @param \Drupal\Core\Routing\UrlGeneratorInterface $urlGenerator
   *   The url generator service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, array $serializer_formats, LoggerInterface $logger, MenuLinkTreeInterface $menuTree, UrlGeneratorInterface $urlGenerator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
    $this->menuTree = $menuTree;
    $this->urlGenerator = $urlGenerator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->getParameter('serializer.formats'), $container
      ->get('logger.factory')
      ->get('rest'), $container
      ->get('menu.link_tree'), $container
      ->get('url_generator'));
  }

  /**
   * Create the menu response.
   *
   * @param string $menu_name
   *   The name of menu to load.
   *
   * @return \Drupal\rest\ResourceResponse
   *   The menu response object.
   */
  public function get($menu_name = NULL) {
    $menu_tree = $this->menuTree;
    $generator = $this->urlGenerator;
    $menu = [];

    // Load the tree based on this set of parameters.
    $tree = $menu_tree
      ->load($menu_name, new MenuTreeParameters());

    // Transform the tree using the manipulators you want.
    $manipulators = [
      // Only show links that are accessible for the current user.
      [
        'callable' => 'menu.default_tree_manipulators:checkAccess',
      ],
      // Use the default sorting of menu links.
      [
        'callable' => 'menu.default_tree_manipulators:generateIndexAndSort',
      ],
    ];
    $tree = $menu_tree
      ->transform($tree, $manipulators);
    foreach ($tree as $element) {

      /** @var \Drupal\Core\Menu\MenuLinkInterface $link */
      $link = $element->link;
      $path = $generator
        ->getPathFromRoute($link
        ->getRouteName());
      $menu[$link
        ->getRouteName()]['title'] = $link
        ->getTitle();
      $menu[$link
        ->getRouteName()]['url'] = $path;
      if ($element->subtree) {
        $subtree = $menu_tree
          ->build($element->subtree);
        foreach ($subtree['#items'] as $key => $value) {
          $path = $generator
            ->getPathFromRoute($key);
          $menu[$key]['title'] = $value['title'];
          $menu[$key]['url'] = $path;

          // For getting submenu list.
          foreach ($subtree['#items'][$key]['below'] as $subkey => $subvalue) {
            $path = $generator
              ->getPathFromRoute($subkey);
            $menu[$key]['below'][$subkey]['title'] = $subvalue['title'];
            $menu[$key]['below'][$subkey]['url'] = $path;
          }
        }
      }
    }
    $response = new ResourceResponse($menu);
    $response
      ->addCacheableDependency($menu);
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ResourceBase::$logger protected property A logger instance.
ResourceBase::$serializerFormats protected property The available serialization formats.
ResourceBase::availableMethods public function Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods 1
ResourceBase::getBaseRoute protected function Gets the base route for a particular method. 2
ResourceBase::getBaseRouteRequirements protected function Gets the base route requirements for a particular method. 1
ResourceBase::permissions public function Implements ResourceInterface::permissions(). Overrides ResourceInterface::permissions 2
ResourceBase::requestMethods protected function Provides predefined HTTP request methods.
ResourceBase::routes public function Returns a collection of routes with URL path information for the resource. Overrides ResourceInterface::routes
ServicesMenuResource::$menuTree protected property The menu tree.
ServicesMenuResource::$urlGenerator protected property The url generator service.
ServicesMenuResource::create public static function Creates an instance of the plugin. Overrides ResourceBase::create
ServicesMenuResource::get public function Create the menu response.
ServicesMenuResource::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides ResourceBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.