class EntityRendered in GraphQL 8.3

Plugin annotation

@GraphQLField(
  id = "entity_rendered",
  name = "entityRendered",
  type = "String",
  secure = true,
  deriver = "Drupal\graphql_core\Plugin\Deriver\Fields\EntityRenderedDeriver",
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase implements FieldPluginInterface uses ArgumentAwarePluginTrait, CacheablePluginTrait, DeprecatablePluginTrait, DescribablePluginTrait, TypedPluginTrait
    • class \Drupal\graphql_core\Plugin\GraphQL\Fields\Entity\EntityRendered implements ContainerFactoryPluginInterface uses DependencySerializationTrait

File

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityRendered.php, line 26

Namespace

Drupal\graphql_core\Plugin\GraphQL\Fields\Entity

class EntityRendered extends FieldPluginBase implements ContainerFactoryPluginInterface {
  use DependencySerializationTrait;

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $pluginId, $pluginDefinition) {
    return new static($configuration, $pluginId, $pluginDefinition, $container
      ->get('entity_type.manager'), $container
      ->get('renderer'));
  }

  /**
   * EntityRendered constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(array $configuration, $pluginId, $pluginDefinition, EntityTypeManagerInterface $entityTypeManager, RendererInterface $renderer) {
    parent::__construct($configuration, $pluginId, $pluginDefinition);
    $this->entityTypeManager = $entityTypeManager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public function resolveValues($value, array $args, ResolveContext $context, ResolveInfo $info) {
    if ($value instanceof ContentEntityInterface) {
      $mode = isset($args['mode']) ? $args['mode'] : 'full';
      $language = $value
        ->language()
        ->getId();
      $builder = $this->entityTypeManager
        ->getViewBuilder($value
        ->getEntityTypeId());
      $view = $builder
        ->view($value, $mode, $language);
      $context = new RenderContext();

      /** @var \GraphQL\Executor\ExecutionResult|\GraphQL\Executor\ExecutionResult[] $result */
      $result = $this->renderer
        ->executeInRenderContext($context, function () use ($view) {
        return $this->renderer
          ->render($view);
      });
      if (!$context
        ->isEmpty()) {
        (yield new CacheableValue((string) $result, [
          $context
            ->pop(),
        ]));
      }
      else {
        (yield (string) $result);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArgumentAwarePluginTrait::buildArgumentDefault	protected	function	Builds an argument's default value.
ArgumentAwarePluginTrait::buildArgumentDescription	protected	function	Builds an argument's description.
ArgumentAwarePluginTrait::buildArguments	protected	function	Builds the list of arguments.
ArgumentAwarePluginTrait::buildArgumentType	protected	function	Builds an argument's type.
CacheablePluginTrait::buildCacheContexts	protected	function
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
DeprecatablePluginTrait::buildDeprecationReason	protected	function
DescribablePluginTrait::buildDescription	protected	function
EntityRendered::$entityTypeManager	protected	property	The entity type manager service.
EntityRendered::$renderer	protected	property	The renderer service. Overrides FieldPluginBase::$renderer
EntityRendered::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityRendered::resolveValues	public	function	Retrieve the list of field values. Overrides FieldPluginBase::resolveValues
EntityRendered::__construct	public	function	EntityRendered constructor. Overrides PluginBase::__construct
FieldPluginBase::$isLanguageAware	protected	property	Static cache for `isLanguageAwareField()`
FieldPluginBase::$languageContext	protected	property	The language context service.
FieldPluginBase::createInstance	public static	function	Overrides FieldPluginInterface::createInstance
FieldPluginBase::getCacheDependencies	protected	function	Retrieve the list of cache dependencies for a given value and arguments.	1
FieldPluginBase::getDefinition	public	function	Returns the plugin's type or field definition for the schema. Overrides FieldPluginInterface::getDefinition
FieldPluginBase::getLanguageContext	protected	function	Get the language context instance.
FieldPluginBase::getRenderer	protected	function	Get the renderer service.
FieldPluginBase::isLanguageAwareField	protected	function	Indicator if the field is language aware.	1
FieldPluginBase::resolve	public	function		1
FieldPluginBase::resolveDeferred	protected	function
FieldPluginBase::unwrapResult	protected	function	Unwrap the resolved values.
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.
TypedPluginTrait::buildType	protected	function