Adding targeted entity interfaces. (#511)

Author: fubhy

modules/graphql_core/src/Plugin/Deriver/Fields/EntityRenderedDeriver.php

@@ -49,12 +49,6 @@ public function getDerivativeDefinitions($basePluginDefinition) {
           'entity_type' => $id,
         ] + $basePluginDefinition;
 
-        if ($type->isTranslatable()) {
-          $derivative['arguments']['language'] = [
-            'type' => 'LanguageId',
-          ];
-        }
-
         $this->derivatives["entity:$id"] = $derivative;
       }
     }

modules/graphql_core/src/Plugin/Deriver/Interfaces/EntityTypeDeriver.php

@@ -4,6 +4,7 @@
 
 use Drupal\Component\Plugin\Derivative\DeriverBase;
 use Drupal\Core\Entity\ContentEntityTypeInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
@@ -46,19 +47,52 @@ public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    * {@inheritdoc}
    */
   public function getDerivativeDefinitions($basePluginDefinition) {
-    $this->derivatives = [];
     foreach ($this->entityTypeManager->getDefinitions() as $typeId => $type) {
-      if ($type instanceof ContentEntityTypeInterface) {
-        $this->derivatives[$typeId] = [
-          'name' => StringHelper::camelCase($typeId),
-          'description' => $this->t("The '@type' entity type.", [
-            '@type' => $type->getLabel(),
-          ]),
-          'type' => "entity:$typeId",
-        ] + $basePluginDefinition;
+      if (!$type instanceof ContentEntityTypeInterface) {
+        continue;
       }
+
+      $interfaces = isset($basePluginDefinition['interfaces']) ? $basePluginDefinition['interfaces'] : [];
+      $interfaces = array_unique(array_merge($interfaces, $this->getInterfaces($type)));
+
+      $this->derivatives[$typeId] = [
+        'name' => StringHelper::camelCase($typeId),
+        'description' => $this->t("The '@type' entity type.", [
+          '@type' => $type->getLabel(),
+        ]),
+        'type' => "entity:$typeId",
+        'interfaces' => $interfaces,
+      ] + $basePluginDefinition;
     }
+
     return parent::getDerivativeDefinitions($basePluginDefinition);
   }
 
+  /**
+   * Retrieve the interfaces that the entity type should implement.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeInterface $type
+   *   The entity type to retrieve the interfaces for.
+   *
+   * @return array
+   *   The interfaces that this entity type should implement.
+   */
+  protected function getInterfaces(EntityTypeInterface $type) {
+    $pairs = [
+      '\Drupal\Core\Entity\EntityDescriptionInterface' => 'EntityDescribable',
+      '\Drupal\Core\Entity\EntityPublishedInterface' => 'EntityPublishable',
+      '\Drupal\Core\Entity\RevisionableInterface' => 'EntityRevisionable',
+      '\Drupal\user\EntityOwnerInterface' => 'EntityOwnable',
+    ];
+
+    $interfaces = [];
+    foreach ($pairs as $dependency => $interface) {
+      if ($type->entityClassImplements($dependency)) {
+        $interfaces[] = $interface;
+      }
+    }
+
+    return $interfaces;
+  }
+
 }

modules/graphql_core/src/Plugin/GraphQL/Fields/Blocks/BlocksByRegion.php

@@ -24,7 +24,7 @@
  *   id = "blocks_by_region",
  *   secure = true,
  *   name = "blocksByRegion",
- *   type = "[Entity]",
+ *   type = "[entity:block]",
  *   parents = {"InternalUrl"},
  *   arguments = {
  *     "region" = "String!"

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityChanged.php

@@ -8,6 +8,8 @@
 use DateTime;
 
 /**
+ * TODO: Should we derive this for each entity type individually?
+ *
  * @GraphQLField(
  *   id = "entity_changed",
  *   secure = true,

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityCreated.php

@@ -7,6 +7,8 @@
 use DateTime;
 
 /**
+ * TODO: Should we derive this for each entity type individually?
+ *
  * @GraphQLField(
  *   id = "entity_created",
  *   secure = true,

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityDescription.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;
+
+use Drupal\Core\Entity\EntityDescriptionInterface;
+use Drupal\graphql\Plugin\GraphQL\Fields\FieldPluginBase;
+use Youshido\GraphQL\Execution\ResolveInfo;
+
+/**
+ * @GraphQLField(
+ *   id = "entity_description",
+ *   secure = true,
+ *   name = "entityDescription",
+ *   type = "String",
+ *   parents = {"EntityDescribable"}
+ * )
+ */
+class EntityDescription extends FieldPluginBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function resolveValues($value, array $args, ResolveInfo $info) {
+    if ($value instanceof EntityDescriptionInterface) {
+      yield $value->getDescription();
+    }
+  }
+
+}

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityOwner.php

@@ -12,7 +12,7 @@
  *   secure = true,
  *   name = "entityOwner",
  *   type = "entity:user",
- *   parents = {"Entity"}
+ *   parents = {"EntityOwnable"}
  * )
  */
 class EntityOwner extends FieldPluginBase {

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityPublished.php

@@ -12,7 +12,7 @@
  *   secure = true,
  *   name = "entityPublished",
  *   type = "Boolean",
- *   parents = {"Entity"}
+ *   parents = {"EntityPublishable"}
  * )
  */
 class EntityPublished extends FieldPluginBase {

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityRendered.php

@@ -95,8 +95,7 @@ protected function buildArguments(PluggableSchemaBuilderInterface $schemaBuilder
   public function resolveValues($value, array $args, ResolveInfo $info) {
     if ($value instanceof ContentEntityInterface) {
       $mode = isset($args['mode']) ? $args['mode'] : 'full';
-      $language = isset($args['language']) ? $args['language'] : $value->language()->getId();
-
+      $language = $value->language()->getId();
       $builder = $this->entityTypeManager->getViewBuilder($value->getEntityTypeId());
       $rendered = $builder->view($value, $mode, $language);
       yield $this->renderer->render($rendered);

modules/graphql_core/src/Plugin/GraphQL/Fields/Entity/EntityRevisions.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Drupal\graphql_core\Plugin\GraphQL\Fields\Entity;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\graphql_core\Plugin\GraphQL\Fields\EntityQuery\EntityQuery;
+use Youshido\GraphQL\Execution\ResolveInfo;
+
+/**
+ * @GraphQLField(
+ *   id = "entity_revisions",
+ *   name = "entityRevisions",
+ *   secure = true,
+ *   parents = {"EntityRevisionable"},
+ *   type = "EntityQueryResult!",
+ *   arguments = {
+ *     "filter" = "EntityQueryFilterInput",
+ *     "sort" = "[EntityQuerySortInput]",
+ *     "offset" = {
+ *       "type" = "Int",
+ *       "default" = 0
+ *     },
+ *     "limit" = {
+ *       "type" = "Int",
+ *       "default" = 10
+ *     }
+ *   }
+ * )
+ */
+class EntityRevisions extends EntityQuery {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getBaseQuery($value, array $args, ResolveInfo $info) {
+    if ($value instanceof EntityInterface) {
+      $query = parent::getBaseQuery($value, $args, $info);
+
+      // Add the entity id as a filter condition.
+      $key = $value->getEntityType()->getKey('id');
+      $query->condition($key, $value->id());
+
+      // Mark the query as a revision query.
+      return $this->applyRevisionsMode($query, 'all');
+    }
+  }
+
+}