Prevent geometry type fields from throwing a 'type not found' error (happens with doctrine/dbal when changing field definitions)

Author: grimzy

README.md

@@ -154,6 +154,59 @@ Note about spatial indexes from the [MySQL documentation](https://dev.mysql.com/
 
 > For [`MyISAM`](https://dev.mysql.com/doc/refman/5.7/en/myisam-storage-engine.html) and (as of MySQL 5.7.5) `InnoDB` tables, MySQL can create spatial indexes using syntax similar to that for creating regular indexes, but using the `SPATIAL` keyword. Columns in spatial indexes must be declared `NOT NULL`.
 
+From the command line:
+
+```shell
+php artisan make:migration update_places_table
+```
+
+Then edit the migration you just created:
+
+```php
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class UpdatePlacesTable extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        // MySQL < 5.7.5: table has to be MyISAM
+        // \DB::statement('ALTER TABLE places ENGINE = MyISAM');
+
+        Schema::table('places', function (Blueprint $table) {
+            // Make sure point is not nullable
+            $table->point('location')->change();
+          
+            // Add a spatial index on the location field
+            $table->spatialIndex('location');
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Schema::table('places', function (Blueprint $table) {
+            $table->dropSpatialIndex(['location']); // either an array of column names or the index name
+        });
+
+        // \DB::statement('ALTER TABLE places ENGINE = InnoDB');
+
+        Schema::table('places', function (Blueprint $table) {
+            $table->point('location')->nullable()->change();
+        });
+    }
+}
+```
 ## Models
 
 Available geometry classes:

src/Doctrine/Geometry.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class Geometry extends Type
+{
+    const GEOMETRY = 'geometry';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'geometry';
+    }
+
+    public function getName()
+    {
+        return self::GEOMETRY;
+    }
+}

src/Doctrine/GeometryCollection.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class GeometryCollection extends Type
+{
+    const GEOMETRYCOLLECTION = 'geometrycollection';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'geometrycollection';
+    }
+
+    public function getName()
+    {
+        return self::GEOMETRYCOLLECTION;
+    }
+}

src/Doctrine/LineString.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class LineString extends Type
+{
+    const LINESTRING = 'linestring';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'linestring';
+    }
+
+    public function getName()
+    {
+        return self::LINESTRING;
+    }
+}

src/Doctrine/MultiLineString.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiLineString extends Type
+{
+    const MULTILINESTRING = 'multilinestring';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'multilinestring';
+    }
+
+    public function getName()
+    {
+        return self::MULTILINESTRING;
+    }
+}

src/Doctrine/MultiPoint.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiPoint extends Type
+{
+    const MULTIPOINT = 'multipoint';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'multipoint';
+    }
+
+    public function getName()
+    {
+        return self::MULTIPOINT;
+    }
+}

src/Doctrine/MultiPolygon.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class MultiPolygon extends Type
+{
+    const MULTIPOLYGON = 'multipolygon';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'multipolygon';
+    }
+
+    public function getName()
+    {
+        return self::MULTIPOLYGON;
+    }
+}

src/Doctrine/Point.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class Point extends Type
+{
+    const POINT = 'point';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'point';
+    }
+
+    public function getName()
+    {
+        return self::POINT;
+    }
+}

src/Doctrine/Polygon.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Doctrine;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+
+class Polygon extends Type
+{
+    const POLYGON = 'polygon';
+
+    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
+    {
+        return 'polygon';
+    }
+
+    public function getName()
+    {
+        return self::POLYGON;
+    }
+}

src/MysqlConnection.php

@@ -4,13 +4,28 @@
 
 class MysqlConnection extends \Illuminate\Database\MySqlConnection
 {
-//    public function __construct($pdo, $database = '', $tablePrefix = '', array $config = [])
-//    {
-//        parent::__construct($pdo, $database, $tablePrefix, $config);
-//
-//        // Prevent geography type fields from throwing a 'type not found' error.
-//        $this->getDoctrineSchemaManager()->getDatabasePlatform()->registerDoctrineTypeMapping('geography', 'string');
-//    }
+    public function __construct($pdo, $database = '', $tablePrefix = '', array $config = [])
+    {
+        parent::__construct($pdo, $database, $tablePrefix, $config);
+
+        if(class_exists('Doctrine\DBAL\Types\Type')) {
+            // Prevent geometry type fields from throwing a 'type not found' error when changing them
+            $geometries = [
+                'geometry',
+                'point',
+                'linestring',
+                'polygon',
+                'multipoint',
+                'multilinestring',
+                'multipolygon',
+                'geometrycollection',
+            ];
+            $dbPlatform = $this->getDoctrineSchemaManager()->getDatabasePlatform();
+            foreach($geometries as $type) {
+                $dbPlatform->registerDoctrineTypeMapping($type, 'string');
+            }
+        }
+    }
 
     /**
      * Get the default schema grammar instance.