class VocabularyTreeGet in Services 9.0.x
Same name and namespace in other branches
- 8.4 src/Plugin/ServiceDefinition/VocabularyTreeGet.php \Drupal\services\Plugin\ServiceDefinition\VocabularyTreeGet
Plugin annotation
@ServiceDefinition(
id = "vocabulary_tree_get",
methods = {
"GET"
},
translatable = true,
title = @Translation("Taxonomy Vocabulary Get Tree"),
description = @Translation("Returns term hierarchy."),
category = @Translation("Taxonomy"),
path = "taxonomy/{vocabulary}/get-tree"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, ContextAwarePluginTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\services\ServiceDefinitionBase implements ServiceDefinitionInterface
- class \Drupal\services\Plugin\ServiceDefinition\VocabularyTreeGet implements ContainerFactoryPluginInterface
- class \Drupal\services\ServiceDefinitionBase implements ServiceDefinitionInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, ContextAwarePluginTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of VocabularyTreeGet
File
- src/
Plugin/ ServiceDefinition/ VocabularyTreeGet.php, line 25
Namespace
Drupal\services\Plugin\ServiceDefinitionView source
class VocabularyTreeGet extends ServiceDefinitionBase implements ContainerFactoryPluginInterface {
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
/*public function processRoute(Route $route) {
// TODO - Check perms of taxonomy vocabulary access.
//$route->setRequirement('_entity_access', $this->getDerivativeId() .'.view');
}*/
/**
* {@inheritdoc}
*/
public function processRequest(Request $request, RouteMatchInterface $route_match, SerializerInterface $serializer) {
// The query string parameter 'path' must exist in order to load the
// node that correlates to path value provided.
/*if (!$request->query->has('vocabulary')) {
throw new HttpException(404);
}*/
$vocabulary_id = $request
->get('vocabulary');
/* @var $termStorage \Drupal\taxonomy\TermStorageInterface */
$termStorage = \Drupal::entityTypeManager()
->getStorage('taxonomy_term');
// Load taxonomy terms for tax menu vocab.
/* @var $terms \Drupal\taxonomy\TermInterface[] */
$terms = $termStorage
->loadTree($vocabulary_id);
$terms_array = [];
/* @var $term \Drupal\taxonomy\TermInterface */
foreach ($terms as $term) {
$terms_array[] = (array) $term;
}
return $terms_array;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextAwarePluginBase:: |
protected | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides PluginBase:: |
|
ContextAwarePluginTrait:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginTrait:: |
protected | property | Tracks whether the context has been initialized from configuration. | |
ContextAwarePluginTrait:: |
public | function | 9 | |
ContextAwarePluginTrait:: |
public | function | 7 | |
ContextAwarePluginTrait:: |
public | function | 4 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
abstract protected | function | 1 | |
ContextAwarePluginTrait:: |
public | function | 1 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
ServiceDefinitionBase:: |
public | function |
Returns an array of service request arguments. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Returns a translated string for the category. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Returns a translated description for the constraint description. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Return an array of allowed methods. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Returns the appended path for the service. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Returns a translated string for the service title. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Allow plugins to alter the response object before it is returned. Overrides ServiceDefinitionInterface:: |
|
ServiceDefinitionBase:: |
public | function |
Checks access for the ServiceDefintion. Overrides ServiceDefinitionInterface:: |
7 |
ServiceDefinitionBase:: |
public | function |
Returns a boolean if this service definition supports translations. Overrides ServiceDefinitionInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |
VocabularyTreeGet:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
VocabularyTreeGet:: |
public | function |
Processes the request and returns an array of data as appropriate. Overrides ServiceDefinitionInterface:: |