Merge pull request #14 from moufmouf/implement_interface

Adding ability to implement an interface in DAO and beans

Author: moufmouf

README.md

@@ -41,6 +41,11 @@ $db->table('posts')
                       ->protectedSetter() // The Post.setUser() method is protected
                       ->protectedOneToMany() // The User.getPosts() method is protected
 
+// Customize implemented interfaces
+$db->table('posts')
+   ->implementsInterface('App\\PostInterface')  // The generated bean will implement interface App\\PostInterface
+   ->implementsInterfaceOnDao('App\\PostDaoInterface'); // The generated DAO will implement interface App\\PostDaoInterface
+
 // The "posts" table will generate a GraphQL type (i.e. the bean will be annotated with the GraphQLite @Type annotation).
 $posts = $db->table('posts')->graphqlType();
 

src/TdbmFluidTable.php

@@ -77,7 +77,7 @@ public function uuid(string $version = 'v4'): TdbmFluidColumnOptions
         return $this->column('uuid')->guid();
     }
 
-    public function timestamps(): TdbmFluidTable
+    public function timestamps(): self
     {
         $this->fluidTable->timestamps();
         return $this;
@@ -86,7 +86,7 @@ public function timestamps(): TdbmFluidTable
     /**
      * @throws FluidSchemaException
      */
-    public function extends(string $tableName): TdbmFluidTable
+    public function extends(string $tableName): self
     {
         $this->fluidTable->extends($tableName);
         return $this;
@@ -95,7 +95,7 @@ public function extends(string $tableName): TdbmFluidTable
     /**
      * Adds a "Bean" annotation to the table.
      */
-    public function customBeanName(string $beanName): TdbmFluidTable
+    public function customBeanName(string $beanName): self
     {
         $this->addAnnotation('Bean', ['name'=>$beanName]);
         return $this;
@@ -104,12 +104,36 @@ public function customBeanName(string $beanName): TdbmFluidTable
     /**
      * Adds a "Type" annotation.
      */
-    public function graphqlType(): TdbmFluidTable
+    public function graphqlType(): self
     {
         $this->addAnnotation('TheCodingMachine\\GraphQLite\\Annotations\\Type');
         return $this;
     }
 
+    /**
+     * Makes the generated bean implement the interface $interfaceName
+     *
+     * @param string $interfaceName The fully qualified name of the PHP interface to implement.
+     * @return TdbmFluidTable
+     */
+    public function implementsInterface(string $interfaceName): self
+    {
+        $this->addAnnotation('AddInterface', ['name' => $interfaceName], false);
+        return $this;
+    }
+
+    /**
+     * Makes the generated DAO implement the interface $interfaceName
+     *
+     * @param string $interfaceName The fully qualified name of the PHP interface to implement.
+     * @return TdbmFluidTable
+     */
+    public function implementsInterfaceOnDao(string $interfaceName): self
+    {
+        $this->addAnnotation('AddInterfaceOnDao', ['name' => $interfaceName], false);
+        return $this;
+    }
+
     private function getComment(): Comment
     {
         $options = $this->fluidTable->getDbalTable()->getOptions();

tests/TdbmFluidTableTest.php

@@ -123,6 +123,30 @@ public function testCustomBeanName()
         $this->assertSame("\n@Bean(name = \"Article\")", $schema->getTable('posts')->getOptions()['comment']);
     }
 
+    public function testImplementsInterface()
+    {
+        $schema = new Schema();
+        $fluid = new TdbmFluidSchema($schema);
+
+        $posts = $fluid->table('posts');
+
+        $posts->implementsInterface('Foo\\Bar');
+        $posts->implementsInterface('Foo\\Bar2');
+
+        $this->assertSame("\n@AddInterface(name = \"Foo\\Bar\")\n@AddInterface(name = \"Foo\\Bar2\")", $schema->getTable('posts')->getOptions()['comment']);
+    }
+
+    public function testImplementsInterfaceOnDao()
+    {
+        $schema = new Schema();
+        $fluid = new TdbmFluidSchema($schema);
+
+        $posts = $fluid->table('posts');
+
+        $posts->implementsInterfaceOnDao('Foo\\Bar');
+
+        $this->assertSame("\n@AddInterfaceOnDao(name = \"Foo\\Bar\")", $schema->getTable('posts')->getOptions()['comment']);
+    }
 
     public function testTimestamps()
     {