abstract class CreateEntityBase in GraphQL 8.3

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\graphql\Plugin\GraphQL\Mutations\MutationPluginBase implements MutationPluginInterface uses ArgumentAwarePluginTrait, DeprecatablePluginTrait, DescribablePluginTrait, TypedPluginTrait
  - class \Drupal\graphql_core\Plugin\GraphQL\Mutations\Entity\CreateEntityBase implements ContainerFactoryPluginInterface uses DependencySerializationTrait, StringTranslationTrait

Expanded class hierarchy of CreateEntityBase

1 file declares its use of CreateEntityBase

EntityMutationTest.php in modules/graphql_core/tests/src/Kernel/EntityMutation/EntityMutationTest.php

File

modules/graphql_core/src/Plugin/GraphQL/Mutations/Entity/CreateEntityBase.php, line 19

Namespace

Drupal\graphql_core\Plugin\GraphQL\Mutations\Entity

View source

abstract class CreateEntityBase extends MutationPluginBase implements ContainerFactoryPluginInterface {
  use DependencySerializationTrait;
  use StringTranslationTrait;

  /**
   * The entity type manager.
   *
   * @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'));
  }

  /**
   * CreateEntityBase constructor.
   *
   * @param array $configuration
   *   The plugin configuration array.
   * @param string $pluginId
   *   The plugin id.
   * @param mixed $pluginDefinition
   *   The plugin definition array.
   * @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 resolve($value, array $args, ResolveContext $context, ResolveInfo $info) {

    // There are cases where the Drupal entity API calls emit the cache metadata
    // in the current render context. In such cases
    // EarlyRenderingControllerWrapperSubscriber throws the leaked cache
    // metadata exception. To avoid this, wrap the execution in its own render
    // context.
    return $this->renderer
      ->executeInRenderContext(new RenderContext(), function () use ($value, $args, $context, $info) {
      $entityTypeId = $this->pluginDefinition['entity_type'];

      // The raw input needs to be converted to use the proper field and property
      // keys because we usually convert them to camel case when adding them to
      // the schema.
      $input = $this
        ->extractEntityInput($value, $args, $context, $info);
      $entityDefinition = $this->entityTypeManager
        ->getDefinition($entityTypeId);
      if ($entityDefinition
        ->hasKey('bundle')) {
        $bundleName = $this->pluginDefinition['entity_bundle'];
        $bundleKey = $entityDefinition
          ->getKey('bundle');

        // Add the entity's bundle with the correct key.
        $input[$bundleKey] = $bundleName;
      }
      $storage = $this->entityTypeManager
        ->getStorage($entityTypeId);
      $entity = $storage
        ->create($input);
      return $this
        ->resolveOutput($entity, $args, $info);
    });
  }

  /**
   * Extract entity values from the resolver args.
   *
   * Loops over all input values and assigns them to their original field names.
   *
   * @param $value
   *   The parent value.
   * @param array $args
   *   The entity values provided through the resolver args.
   * @param \Drupal\graphql\GraphQL\Execution\ResolveContext $context
   *   The resolve context.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return array
   *   The extracted entity values with their proper, internal field names.
   */
  protected abstract function extractEntityInput($value, array $args, ResolveContext $context, ResolveInfo $info);

  /**
   * Formats the output of the mutation.
   *
   * The default implementation wraps the created entity in another object to
   * transport possible error messages and constraint violations after applying
   * some access checks and input validation.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The created entity.
   * @param array $args
   *   The arguments array.
   * @param \GraphQL\Type\Definition\ResolveInfo $info
   *   The resolve info object.
   *
   * @return mixed
   *   The output for the created entity.
   */
  protected function resolveOutput(EntityInterface $entity, array $args, ResolveInfo $info) {
    if (!$entity
      ->access('create')) {
      return new EntityCrudOutputWrapper(NULL, NULL, [
        $this
          ->t('You do not have the necessary permissions to create entities of this type.'),
      ]);
    }
    if ($entity instanceof ContentEntityInterface) {
      if (($violations = $entity
        ->validate()) && $violations
        ->count()) {
        return new EntityCrudOutputWrapper(NULL, $violations);
      }
    }
    if (($status = $entity
      ->save()) && $status === SAVED_NEW) {
      return new EntityCrudOutputWrapper($entity);
    }
    return NULL;
  }

}

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.
CreateEntityBase::$entityTypeManager	protected	property	The entity type manager.
CreateEntityBase::$renderer	protected	property	The renderer service.
CreateEntityBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
CreateEntityBase::extractEntityInput	abstract protected	function	Extract entity values from the resolver args.
CreateEntityBase::resolve	public	function
CreateEntityBase::resolveOutput	protected	function	Formats the output of the mutation.
CreateEntityBase::__construct	public	function	CreateEntityBase constructor. Overrides PluginBase::__construct
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
MutationPluginBase::createInstance	public static	function	Overrides MutationPluginInterface::createInstance
MutationPluginBase::getDefinition	public	function	Returns the plugin's type or field definition for the schema. Overrides MutationPluginInterface::getDefinition
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TypedPluginTrait::buildType	protected	function

You are here

abstract class CreateEntityBase in GraphQL 8.3

Hierarchy

File

Namespace

Members

API Navigation