class ServicesMenuResource in Services Menu 8

Provides a service resource for menus.

Plugin annotation

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

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\rest\Plugin\ResourceBase implements ContainerFactoryPluginInterface, ResourceInterface
      • class \Drupal\services_menu\Plugin\rest\resource\ServicesMenuResource

File

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

Namespace

Drupal\services_menu\Plugin\rest\resource

class ServicesMenuResource extends ResourceBase {

  /**
   * @param null $menu_name
   * @return ResourceResponse
   */
  public function get($menu_name = NULL) {
    $menu_tree = \Drupal::menuTree();
    $generator = \Drupal::urlGenerator();

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

    // Transform the tree using the manipulators you want.
    $manipulators = array(
      // Only show links that are accessible for the current user.
      array(
        'callable' => 'menu.default_tree_manipulators:checkAccess',
      ),
      // Use the default sorting of menu links.
      array(
        '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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	3
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
ResourceBase::__construct	public	function	Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase::__construct	3
ServicesMenuResource::get	public	function
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.