EntityLoadByUuid.php in GraphQL 8.4
File
src/Plugin/GraphQL/DataProducer/Entity/EntityLoadByUuid.phpView source
<?php
namespace Drupal\graphql\Plugin\GraphQL\DataProducer\Entity;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\TranslatableInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\graphql\GraphQL\Buffers\EntityUuidBuffer;
use Drupal\graphql\GraphQL\Execution\FieldContext;
use Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase;
use GraphQL\Deferred;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Loads an entity by UUID.
*
* @DataProducer(
* id = "entity_load_by_uuid",
* name = @Translation("Load entity by uuid"),
* description = @Translation("Loads a single entity by uuid."),
* produces = @ContextDefinition("entity",
* label = @Translation("Entity")
* ),
* consumes = {
* "type" = @ContextDefinition("string",
* label = @Translation("Entity type")
* ),
* "uuid" = @ContextDefinition("string",
* label = @Translation("Unique identifier")
* ),
* "language" = @ContextDefinition("string",
* label = @Translation("Entity language"),
* required = FALSE
* ),
* "bundles" = @ContextDefinition("string",
* label = @Translation("Entity bundle(s)"),
* multiple = TRUE,
* required = FALSE
* ),
* "access" = @ContextDefinition("boolean",
* label = @Translation("Check access"),
* required = FALSE,
* default_value = TRUE
* ),
* "access_user" = @ContextDefinition("entity:user",
* label = @Translation("User"),
* required = FALSE,
* default_value = NULL
* ),
* "access_operation" = @ContextDefinition("string",
* label = @Translation("Operation"),
* required = FALSE,
* default_value = "view"
* )
* }
* )
*/
class EntityLoadByUuid extends DataProducerPluginBase implements ContainerFactoryPluginInterface {
/**
* The entity type manager service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The entity repository service.
*
* @var \Drupal\Core\Entity\EntityRepositoryInterface
*/
protected $entityRepository;
/**
* The entity buffer service.
*
* @var \Drupal\graphql\GraphQL\Buffers\EntityUuidBuffer
*/
protected $entityBuffer;
/**
* {@inheritdoc}
*
* @codeCoverageIgnore
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.manager'), $container
->get('entity.repository'), $container
->get('graphql.buffer.entity_uuid'));
}
/**
* EntityLoad constructor.
*
* @param array $configuration
* The plugin configuration array.
* @param string $pluginId
* The plugin id.
* @param array $pluginDefinition
* The plugin definition array.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
* The entity type manager service.
* @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
* The entity repository service.
* @param \Drupal\graphql\GraphQL\Buffers\EntityUuidBuffer $entityBuffer
* The entity buffer service.
*
* @codeCoverageIgnore
*/
public function __construct(array $configuration, $pluginId, array $pluginDefinition, EntityTypeManagerInterface $entityTypeManager, EntityRepositoryInterface $entityRepository, EntityUuidBuffer $entityBuffer) {
parent::__construct($configuration, $pluginId, $pluginDefinition);
$this->entityTypeManager = $entityTypeManager;
$this->entityRepository = $entityRepository;
$this->entityBuffer = $entityBuffer;
}
/**
* Resolver.
*
* @param string $type
* @param string $uuid
* @param string|null $language
* @param array|null $bundles
* @param bool|null $access
* @param \Drupal\Core\Session\AccountInterface|null $accessUser
* @param string|null $accessOperation
* @param \Drupal\graphql\GraphQL\Execution\FieldContext $context
*
* @return \GraphQL\Deferred
*/
public function resolve($type, $uuid, ?string $language, ?array $bundles, ?bool $access, ?AccountInterface $accessUser, ?string $accessOperation, FieldContext $context) {
$resolver = $this->entityBuffer
->add($type, $uuid);
return new Deferred(function () use ($type, $language, $bundles, $resolver, $context, $access, $accessUser, $accessOperation) {
if (!($entity = $resolver())) {
// If there is no entity with this id, add the list cache tags so that
// the cache entry is purged whenever a new entity of this type is
// saved.
$type = $this->entityTypeManager
->getDefinition($type);
/** @var \Drupal\Core\Entity\EntityTypeInterface $type */
$tags = $type
->getListCacheTags();
$context
->addCacheTags($tags);
return NULL;
}
$context
->addCacheableDependency($entity);
if (isset($bundles) && !in_array($entity
->bundle(), $bundles)) {
// If the entity is not among the allowed bundles, don't return it.
return NULL;
}
// Get the correct translation.
if (isset($language) && $language != $entity
->language()
->getId() && $entity instanceof TranslatableInterface) {
$entity = $entity
->getTranslation($language);
$entity
->addCacheContexts([
"static:language:{$language}",
]);
}
// Check if the passed user (or current user if none is passed) has access
// to the entity, if not return NULL.
if ($access) {
/** @var \Drupal\Core\Access\AccessResultInterface $accessResult */
$accessResult = $entity
->access($accessOperation, $accessUser, TRUE);
$context
->addCacheableDependency($accessResult);
if (!$accessResult
->isAllowed()) {
return NULL;
}
}
return $entity;
});
}
}
Classes
Name![]() |
Description |
---|---|
EntityLoadByUuid | Loads an entity by UUID. |