class EntityView in Services 8.4
Same name in this branch
- 8.4 src/Plugin/Deriver/EntityView.php \Drupal\services\Plugin\Deriver\EntityView
- 8.4 src/Plugin/ServiceDefinition/EntityView.php \Drupal\services\Plugin\ServiceDefinition\EntityView
Same name and namespace in other branches
- 9.0.x src/Plugin/ServiceDefinition/EntityView.php \Drupal\services\Plugin\ServiceDefinition\EntityView
Plugin annotation
@ServiceDefinition(
id = "entity_view",
methods = {
"GET"
},
translatable = true,
deriver = "\Drupal\services\Plugin\Deriver\EntityView"
)
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, StringTranslationTrait, TypedDataTrait
- class \Drupal\services\ServiceDefinitionBase implements ServiceDefinitionInterface
- class \Drupal\services\Plugin\ServiceDefinition\EntityView implements ContainerFactoryPluginInterface
- class \Drupal\services\ServiceDefinitionBase implements ServiceDefinitionInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Expanded class hierarchy of EntityView
File
- src/
Plugin/ ServiceDefinition/ EntityView.php, line 27
Namespace
Drupal\services\Plugin\ServiceDefinitionView source
class EntityView extends ServiceDefinitionBase implements ContainerFactoryPluginInterface {
/**
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('renderer'), $container
->get('asset.resolver'), $container
->get('asset.css.collection_renderer'), $container
->get('asset.js.collection_renderer'));
}
/**
* @param array $configuration
* @param string $plugin_id
* @param mixed $plugin_definition
* @param \Drupal\Core\Render\RendererInterface $renderer
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, RendererInterface $renderer, AssetResolverInterface $asset_resolver, AssetCollectionRendererInterface $css_collection_renderer, AssetCollectionRendererInterface $js_collection_renderer) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->renderer = $renderer;
$this->assetResolver = $asset_resolver;
$this->cssCollectionRenderer = $css_collection_renderer;
$this->jsCollectionRenderer = $js_collection_renderer;
}
/**
* {@inheritdoc}
*/
public function processRoute(Route $route) {
$route
->setRequirement('_entity_access', $this
->getDerivativeId() . '.view');
}
/**
* {@inheritdoc}
*/
public function processRequest(Request $request, RouteMatchInterface $route_match, SerializerInterface $serializer) {
$view_mode = 'full';
if ($request->query
->has('view_mode')) {
$view_mode = $request->query
->get('view_mode');
}
/** @var \Drupal\Core\Entity\EntityInterface $entity */
$entity = $this
->getContextValue($this
->getDerivativeId());
$view_builder = \Drupal::entityTypeManager()
->getViewBuilder($entity
->getEntityTypeId());
$render_array = $view_builder
->view($entity, $view_mode);
$result = [];
$result['body'] = $this->renderer
->renderRoot($render_array);
$all_assets = $this
->gatherAssetMarkup($render_array);
$result += $this
->renderAssets($all_assets);
return $result;
}
/**
* Renders an array of assets.
*
* @param array $all_assets
* An array of all unrendered assets keyed by type.
*
* @return array
* An array of all rendered assets keyed by type.
*/
protected function renderAssets(array $all_assets) {
$result = [];
foreach ($all_assets as $asset_type => $assets) {
$result[$asset_type] = [];
foreach ($assets as $asset) {
$result[$asset_type][] = $this->renderer
->renderRoot($asset);
}
}
return $result;
}
/**
* Gathers the markup for each type of asset.
*
* @param array $render_array
* The render array for the entity.
*
* @return array
* An array of rendered assets. See self::getRenderedEntity() for the keys.
*
* @todo template_preprocess_html() should be split up and made reusable.
*/
protected function gatherAssetMarkup(array $render_array) {
$assets = AttachedAssets::createFromRenderArray($render_array);
// Render the asset collections.
$css_assets = $this->assetResolver
->getCssAssets($assets, FALSE);
$variables['styles'] = $this->cssCollectionRenderer
->render($css_assets);
list($js_assets_header, $js_assets_footer) = $this->assetResolver
->getJsAssets($assets, FALSE);
$variables['scripts'] = $this->jsCollectionRenderer
->render($js_assets_header);
$variables['scripts_bottom'] = $this->jsCollectionRenderer
->render($js_assets_footer);
// @todo Handle all non-asset attachments.
// $variables['head'] = drupal_get_html_head(FALSE);
return $variables;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextAwarePluginBase:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginBase:: |
private | property | Data objects representing the contexts passed in the plugin configuration. | |
ContextAwarePluginBase:: |
protected | function | Wraps the context handler. | |
ContextAwarePluginBase:: |
protected | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
9 |
ContextAwarePluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
7 |
ContextAwarePluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
4 |
ContextAwarePluginBase:: |
public | function |
This code is identical to the Component in order to pick up a different
Context class. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the value for a defined context. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Gets the values for all defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Set a context on this plugin. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function |
Sets the value for a defined context. Overrides ContextAwarePluginBase:: |
|
ContextAwarePluginBase:: |
public | function |
Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface:: |
|
ContextAwarePluginBase:: |
public | function | Implements magic __get() method. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityView:: |
protected | property | ||
EntityView:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
EntityView:: |
protected | function | Gathers the markup for each type of asset. | |
EntityView:: |
public | function |
Processes the request and returns an array of data as appropriate. Overrides ServiceDefinitionInterface:: |
|
EntityView:: |
public | function |
Checks access for the ServiceDefintion. Overrides ServiceDefinitionBase:: |
|
EntityView:: |
protected | function | Renders an array of assets. | |
EntityView:: |
public | function |
Overrides ContextAwarePluginBase:: |
|
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 definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
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 |
Returns a boolean if this service definition supports translations. Overrides ServiceDefinitionInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
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 |