Merge pull request #30 from laravel-doctrine/extensions-support

V1.2 - Extensions support

Author: patrickbrouwers

composer.json

@@ -32,11 +32,13 @@
     "mockery/mockery": "~0.9",
     "beberlei/DoctrineExtensions": "~1.0",
     "zf1/zend-date": "~1.12",
-    "nesbot/carbon": "*"
+    "nesbot/carbon": "*",
+    "gedmo/doctrine-extensions": "^2.4"
   },
   "autoload": {
     "psr-4": {
-      "LaravelDoctrine\\Fluent\\": "src/"
+      "LaravelDoctrine\\Fluent\\": "src/",
+      "Gedmo\\": "lib/"
     }
   },
   "autoload-dev": {

lib/Blameable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Blameable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Blameable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/FluentExtension.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Gedmo;
+
+use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
+use Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain;
+use Gedmo\Mapping\Driver;
+use LaravelDoctrine\Fluent\Extensions\ExtensibleClassMetadata;
+use LaravelDoctrine\Fluent\FluentDriver;
+
+abstract class FluentExtension implements Driver
+{
+    /**
+     * @var FluentDriver
+     */
+    protected $originalDriver;
+
+    /**
+     * @return string
+     */
+    abstract protected function getExtensionName();
+
+    /**
+     * Read extended metadata configuration for
+     * a single mapped class
+     *
+     * @param ExtensibleClassMetadata $meta
+     * @param array                   $config
+     *
+     * @return void
+     */
+    public function readExtendedMetadata($meta, array &$config)
+    {
+        if (! $meta instanceof ExtensibleClassMetadata) {
+            return;
+        }
+
+        $config = array_merge_recursive($config, $meta->getExtension(
+            $this->getExtensionName()
+        ));
+    }
+
+    /**
+     * Make sure the original driver is Fluent.
+     *
+     * @param  MappingDriver $driver
+     * @return void
+     */
+    public function setOriginalDriver($driver)
+    {
+        $this->originalDriver = $this->extractFluentDriver($driver);
+    }
+
+    /**
+     * @param MappingDriver $driver
+     *
+     * @return FluentDriver
+     */
+    private function extractFluentDriver(MappingDriver $driver)
+    {
+        if ($driver instanceof FluentDriver) {
+            return $driver;
+        }
+
+        if ($driver instanceof MappingDriverChain) {
+            $default = $driver->getDefaultDriver();
+            if ($default instanceof FluentDriver) {
+                return $default;
+            }
+
+            foreach ($driver->getDrivers() as $namespace => $driver) {
+                if ($driver instanceof FluentDriver) {
+                    return $driver;
+                }
+            }
+        }
+
+        throw new \UnexpectedValueException("Fluent driver not found in the driver chain.");
+    }
+}

lib/IpTraceable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\IpTraceable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'IpTraceable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/Loggable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Loggable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Loggable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/Sluggable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Sluggable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Sluggable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/SoftDeleteable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\SoftDeleteable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'softDeleteable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/Sortable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Sortable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Sortable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/Timestampable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Timestampable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Timestampable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}

lib/Translatable/Mapping/Driver/Fluent.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Gedmo\Translatable\Mapping\Driver;
+
+use Gedmo\FluentExtension;
+
+class Fluent extends FluentExtension
+{
+    const EXTENSION_NAME = 'Translatable';
+
+    /**
+     * @return string
+     */
+    protected function getExtensionName()
+    {
+        return self::EXTENSION_NAME;
+    }
+}