Merge pull request #105 from moufmouf/external_disable_inheritance

Adding 'external' and 'disableInheritance' attributes to @type
thecodingmachine · Jul 8, 2019 · 53e5c67 · 53e5c67
2 parents 71a1f49 + 1236aae
commit 53e5c67
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 9 deletions.
diff --git a/docs/annotations_reference.md b/docs/annotations_reference.md
@@ -37,7 +37,8 @@ Attribute      | Compulsory | Type | Definition
 class          | *no*       | string | The targeted class. If no class is passed, the type applies to the current class. The current class is assumed to be an entity. If the "class" attribute is passed, [the class annotated with `@Type` is a service](external_type_declaration.md).
 name           | *no*       | string | The name of the GraphQL type generated. If not passed, the name of the class is used. If the class ends with "Type", the "Type" suffix is removed
 default        | *no*       | bool   | Defaults to *true*. Whether the targeted PHP class should be mapped by default to this type.
-
+external       | *no*       | bool   | Whether this is an [external type declaration](external_type_declaration.md) or not. You usually do not need to use this attribute since this value defaults to true if a "class" attribute is set. This is only useful if you are declaring a type with no PHP class mapping using the "name" attribute.
+disableInheritance       | *no*       | bool   | Out of the box, it a PHP class who is a type extends another PHP class who is a type, GraphQL inheritance is put in place. Use this attribute to remove the default behaviour. The type will not map any fields from the parent class AND will not implement the interface.
 
 ## @ExtendType annotation
 

diff --git a/src/Annotations/Type.php b/src/Annotations/Type.php
@@ -18,7 +18,9 @@
  * @Attributes({
  *   @Attribute("class", type = "string"),
  *   @Attribute("name", type = "string"),
- *   @Attribute("default", type = "bool")
+ *   @Attribute("default", type = "bool"),
+ *   @Attribute("external", type = "bool"),
+ *   @Attribute("disableInheritance", type = "bool")
  * })
  */
 class Type
@@ -32,6 +34,9 @@ class Type
     /** @var bool */
     private $default;
 
+    /** @var bool */
+    private $disableInheritance;
+
     /**
      * Is the class having the annotation a GraphQL type itself?
      *
@@ -44,6 +49,7 @@ class Type
      */
     public function __construct(array $attributes = [])
     {
+        $external = $attributes['external'] ?? null;
         if (isset($attributes['class'])) {
             $this->setClass($attributes['class']);
         } else {
@@ -54,6 +60,14 @@ public function __construct(array $attributes = [])
 
         // If no value is passed for default, "default" = true
         $this->default = $attributes['default'] ?? true;
+
+        $this->disableInheritance = $attributes['disableInheritance'] ?? false;
+
+        if ($external === null) {
+            return;
+        }
+
+        $this->selfType = ! $external;
     }
 
     /**
@@ -96,4 +110,12 @@ public function isDefault(): bool
     {
         return $this->default;
     }
+
+    /**
+     * Returns true if the parent type fields should be ignored.
+     */
+    public function isInheritanceDisabled(): bool
+    {
+        return $this->disableInheritance;
+    }
 }
diff --git a/src/TypeGenerator.php b/src/TypeGenerator.php
@@ -73,7 +73,7 @@ public function mapAnnotatedObject(string $annotatedObjectClassName): MutableObj
             $annotatedObject = null;
         }
 
-        return TypeAnnotatedObjectType::createFromAnnotatedClass($typeName, $typeField->getClass(), $annotatedObject, $this->fieldsBuilder, $this->recursiveTypeMapper, ! $typeField->isDefault());
+        return TypeAnnotatedObjectType::createFromAnnotatedClass($typeName, $typeField->getClass(), $annotatedObject, $this->fieldsBuilder, $this->recursiveTypeMapper, ! $typeField->isDefault(), $typeField->isInheritanceDisabled());
 
         /*return new ObjectType([
             'name' => $typeName,

diff --git a/src/Types/TypeAnnotatedObjectType.php b/src/Types/TypeAnnotatedObjectType.php
@@ -21,14 +21,14 @@ public function __construct(string $className, array $config)
         parent::__construct($config, $className);
     }
 
-    public static function createFromAnnotatedClass(string $typeName, string $className, ?object $annotatedObject, FieldsBuilder $fieldsBuilder, RecursiveTypeMapperInterface $recursiveTypeMapper, bool $doNotMapInterfaces): self
+    public static function createFromAnnotatedClass(string $typeName, string $className, ?object $annotatedObject, FieldsBuilder $fieldsBuilder, RecursiveTypeMapperInterface $recursiveTypeMapper, bool $doNotMapInterfaces, bool $disableInheritance): self
     {
         return new self($className, [
             'name' => $typeName,
-            'fields' => static function () use ($annotatedObject, $recursiveTypeMapper, $className, $fieldsBuilder) {
+            'fields' => static function () use ($annotatedObject, $recursiveTypeMapper, $className, $fieldsBuilder, $disableInheritance) {
                 $parentClass = get_parent_class($className);
                 $parentType  = null;
-                if ($parentClass !== false) {
+                if ($parentClass !== false && $disableInheritance === false) {
                     if ($recursiveTypeMapper->canMapClassToType($parentClass)) {
                         $parentType = $recursiveTypeMapper->mapClassToType($parentClass, null);
                     }
@@ -50,8 +50,8 @@ public static function createFromAnnotatedClass(string $typeName, string $classN
 
                 return $fields;
             },
-            'interfaces' => static function () use ($className, $recursiveTypeMapper, $doNotMapInterfaces) {
-                if ($doNotMapInterfaces === true) {
+            'interfaces' => static function () use ($className, $recursiveTypeMapper, $doNotMapInterfaces, $disableInheritance) {
+                if ($doNotMapInterfaces === true || $disableInheritance === true) {
                     return [];
                 }
 

diff --git a/tests/Annotations/TypeTest.php b/tests/Annotations/TypeTest.php
@@ -7,11 +7,17 @@
 
 class TypeTest extends TestCase
 {
-    public function testException()
+    public function testException(): void
     {
         $type = new Type([]);
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage('Empty class for @Type annotation. You MUST create the Type annotation object using the GraphQLite AnnotationReader');
         $type->getClass();
     }
+
+    public function testExternal(): void
+    {
+        $type = new Type(['external'=>true]);
+        $this->assertSame(false, $type->isSelfType());
+    }
 }