implement custom types and proxies for describe

tflori · May 17, 2017 · 53df755 · 53df755
1 parent 46f2dd6
commit 53df755
Show file tree

Hide file tree

Showing 11 changed files with 307 additions and 58 deletions.
diff --git a/src/Dbal.php b/src/Dbal.php
@@ -4,6 +4,7 @@
 
 use ORM\Dbal\Column;
 use ORM\Dbal\Type;
+use ORM\Dbal\TypeInterface;
 use ORM\Exceptions\NotScalar;
 use ORM\Exceptions\UnsupportedDriver;
 
@@ -28,58 +29,6 @@ abstract class Dbal
     protected static $registeredTypes = [];
     protected static $typeMapping = [];
 
-    public static function setQuotingCharacter($char)
-    {
-        static::$quotingCharacter = $char;
-    }
-
-    public static function setIdentifierDivider($divider)
-    {
-        static::$identifierDivider = $divider;
-    }
-
-    public static function setBooleanTrue($true)
-    {
-        static::$booleanTrue = $true;
-    }
-
-    public static function setBooleanFalse($false)
-    {
-        static::$booleanFalse = $false;
-    }
-
-    /**
-     * @return string
-     */
-    public static function getQuotingCharacter()
-    {
-        return static::$quotingCharacter;
-    }
-
-    /**
-     * @return string
-     */
-    public static function getIdentifierDivider()
-    {
-        return static::$identifierDivider;
-    }
-
-    /**
-     * @return string
-     */
-    public static function getBooleanTrue()
-    {
-        return static::$booleanTrue;
-    }
-
-    /**
-     * @return string
-     */
-    public static function getBooleanFalse()
-    {
-        return static::$booleanFalse;
-    }
-
     /**
      * Dbal constructor.
      *
@@ -224,6 +173,65 @@ public function delete(Entity $entity)
         return true;
     }
 
+    public static function registerType($type)
+    {
+        if (!in_array($type, static::$registeredTypes)) {
+            array_unshift(static::$registeredTypes, $type);
+        }
+    }
+
+    public static function setQuotingCharacter($char)
+    {
+        static::$quotingCharacter = $char;
+    }
+
+    public static function setIdentifierDivider($divider)
+    {
+        static::$identifierDivider = $divider;
+    }
+
+    public static function setBooleanTrue($true)
+    {
+        static::$booleanTrue = $true;
+    }
+
+    public static function setBooleanFalse($false)
+    {
+        static::$booleanFalse = $false;
+    }
+
+    /**
+     * @return string
+     */
+    public static function getQuotingCharacter()
+    {
+        return static::$quotingCharacter;
+    }
+
+    /**
+     * @return string
+     */
+    public static function getIdentifierDivider()
+    {
+        return static::$identifierDivider;
+    }
+
+    /**
+     * @return string
+     */
+    public static function getBooleanTrue()
+    {
+        return static::$booleanTrue;
+    }
+
+    /**
+     * @return string
+     */
+    public static function getBooleanFalse()
+    {
+        return static::$booleanFalse;
+    }
+
     /**
      * Build the insert statement for $entity
      *
@@ -271,13 +279,16 @@ protected function extractParenthesis($type)
     protected function getType($columnDefinition)
     {
         if (isset(static::$typeMapping[$columnDefinition['data_type']])) {
-            return (static::$typeMapping[$columnDefinition['data_type']])::factory($columnDefinition);
+            return call_user_func([static::$typeMapping[$columnDefinition['data_type']], 'factory'], $columnDefinition);
         } else {
-//            foreach (self::$registeredTypes as $class) {
-//                if ($type = $class::fromDefinition($columnDefinition)) {
-//                    return $type;
-//                }
-//            }
+            foreach (self::$registeredTypes as $class) {
+                if ($type = $class::fromDefinition($columnDefinition)) {
+                    if (!$type instanceof TypeInterface) {
+                        throw new Exception('Returned object does not implement TypeInterface');
+                    }
+                    return $type;
+                }
+            }
 
             return new Type\Text();
         }

diff --git a/src/Dbal/Type.php b/src/Dbal/Type.php
@@ -4,6 +4,10 @@
 
 abstract class Type implements TypeInterface
 {
+    /**
+     * {@inheritdoc}
+     * @codeCoverageIgnore void method for types covered by mapping
+     */
     public static function fromDefinition($columnDefinitoin)
     {
         return null;

diff --git a/src/Entity.php b/src/Entity.php
@@ -2,6 +2,7 @@
 
 namespace ORM;
 
+use ORM\Dbal\Column;
 use ORM\Exceptions\IncompletePrimaryKey;
 use ORM\Exceptions\InvalidConfiguration;
 use ORM\Exceptions\InvalidRelation;
@@ -105,6 +106,11 @@ abstract class Entity implements \Serializable
      * @var \ReflectionClass[] */
     protected static $reflections = [];
 
+    /** The fetched column descriptions for the table.
+     * @internal
+     * @var Column[][] */
+    protected static $descriptions;
+
     /**
      * Get the table name
      *
@@ -335,6 +341,18 @@ public static function isAutoIncremented()
         return count(static::getPrimaryKeyVars()) > 1 ? false : static::$autoIncrement;
     }
 
+    /**
+     * Get an array of Columns for this table.
+     *
+     * @param EntityManager $em
+     * @return mixed
+     * @codeCoverageIgnore This is just a proxy
+     */
+    public static function describe(EntityManager $em)
+    {
+        return $em->describe(static::getTableName());
+    }
+
     /**
      * Enforce $namingScheme to $name
      *

diff --git a/src/EntityManager.php b/src/EntityManager.php
@@ -2,6 +2,7 @@
 
 namespace ORM;
 
+use ORM\Dbal\Column;
 use ORM\Dbal\Other;
 use ORM\Exceptions\IncompletePrimaryKey;
 use ORM\Exceptions\InvalidConfiguration;
@@ -57,6 +58,10 @@ class EntityManager
      * @var array */
     protected $options = [];
 
+    /** Already fetched column descriptions
+     * @var Column[][] */
+    protected $descriptions = [];
+
     /**
      * Constructor
      *
@@ -373,6 +378,7 @@ public function getDbal()
      *
      * @param  mixed  $value      The variable that should be returned in SQL syntax
      * @return string
+     * @codeCoverageIgnore This is just a proxy
      */
     public function escapeValue($value)
     {
@@ -384,9 +390,24 @@ public function escapeValue($value)
      *
      * @param string $identifier Identifier to quote
      * @return string
+     * @codeCoverageIgnore This is just a proxy
      */
     public function escapeIdentifier($identifier)
     {
         return $this->getDbal()->escapeIdentifier($identifier);
     }
+
+    /**
+     * Returns an array of columns from $table.
+     *
+     * @param string $table
+     * @return Dbal\Column[]
+     */
+    public function describe($table)
+    {
+        if (!isset($this->descriptions[$table])) {
+            $this->descriptions[$table] = $this->getDbal()->describe($table);
+        }
+        return $this->descriptions[$table];
+    }
 }
diff --git a/tests/Dbal/Type/Custom/Dbal.php b/tests/Dbal/Type/Custom/Dbal.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace ORM\Test\Dbal\Type\Custom;
+
+class Dbal extends \ORM\Dbal
+{
+    public static function getRegisteredTypes()
+    {
+        return self::$registeredTypes;
+    }
+
+    public static function resetRegisteredTypes()
+    {
+        self::$registeredTypes = [];
+    }
+}
diff --git a/tests/Dbal/Type/Custom/Point.php b/tests/Dbal/Type/Custom/Point.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace ORM\Test\Dbal\Type\Custom;
+
+use ORM\Dbal\Type;
+
+class Point extends Type
+{
+
+}