You are here

class MenuTreeResource in Colossal Menu 2.x

Same name and namespace in other branches
  1. 8 modules/colossal_menu_rest/src/Plugin/rest/resource/MenuTreeResource.php \Drupal\colossal_menu_rest\Plugin\rest\resource\MenuTreeResource

Provides a resource to get view modes by entity and bundle.

Plugin annotation


@RestResource(
  id = "colossal_menu_tree",
  label = @Translation("Colossal Menu Tree"),
  uri_paths = {
    "canonical" = "/entity/colossal_menu/{colossal_menu}/tree"
  }
)

Hierarchy

Expanded class hierarchy of MenuTreeResource

File

modules/colossal_menu_rest/src/Plugin/rest/resource/MenuTreeResource.php, line 19

Namespace

Drupal\colossal_menu_rest\Plugin\rest\resource
View source
class MenuTreeResource extends BaseMenuTreeResource {

  /**
   * {@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('colossal_menu.link_tree'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getBaseRoute($canonical_path, $method) {
    $route = parent::getBaseRoute($canonical_path, $method);
    $parameters = $route
      ->getOption('parameters') ?: [];
    $parameters['colossal_menu']['type'] = 'entity:colossal_menu';
    $route
      ->setOption('parameters', $parameters);
    return $route;
  }

}

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
MenuTreeResource::$entityTypeManager protected property The entity manager.
MenuTreeResource::$menuTree protected property Menu Tree.
MenuTreeResource::addAccess protected function Add Access.
MenuTreeResource::addCacheDependencies protected function Add Cache Tags.
MenuTreeResource::addLinkCacheDependencies protected function Add Cache Tags.
MenuTreeResource::checkAccess protected function Check Access.
MenuTreeResource::create public static function Creates an instance of the plugin. Overrides MenuTreeResource::create
MenuTreeResource::get public function
MenuTreeResource::getBaseRoute protected function Gets the base route for a particular method. Overrides MenuTreeResource::getBaseRoute
MenuTreeResource::removeKeys protected function Remove array keys.
MenuTreeResource::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides ResourceBase::__construct
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::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
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.