Merge pull request #4 from codeliner/access-service-locator

Access service locator

README.md

@@ -50,3 +50,36 @@ class Version20130403165433 extends AbstractMigration
     }
 }
 ```
+
+### Accessing ServiceLocator In Migration Class
+
+By implementing the `Zend\ServiceManager\ServiceLocatorAwareInterface` in your migration class you get access to the
+ServiceLocator used in the application.
+
+``` php
+<?php
+
+namespace ZfSimpleMigrations\Migrations;
+
+use ZfSimpleMigrations\Library\AbstractMigration;
+use Zend\Db\Metadata\MetadataInterface;
+use Zend\ServiceManager\ServiceLocatorAwareInterface;
+
+class Version20130403165433 extends AbstractMigration implements ServiceLocatorAwareInterface
+{
+    public static $description = "Migration description";
+
+    public function up(MetadataInterface $schema)
+    {
+         //$this->getServiceLocator()->get(/*Get service by alias*/);
+         //$this->addSql(/*Sql instruction*/);
+
+    }
+
+    public function down(MetadataInterface $schema)
+    {
+        //$this->getServiceLocator()->get(/*Get service by alias*/);
+        //$this->addSql(/*Sql instruction*/);
+    }
+}
+```

src/ZfSimpleMigrations/Controller/MigrateController.php

@@ -130,6 +130,8 @@ protected function getMigration()
             }
 
             $this->migration = new Migration($adapter, $config['migrations'], $this->getMigrationVersionTable(), $output);
+
+            $this->migration->setServiceLocator($this->getServiceLocator());
         }
         return $this->migration;
     }

src/ZfSimpleMigrations/Library/Migration.php

@@ -8,14 +8,16 @@
 use Zend\Db\Metadata\Metadata;
 use Zend\Db\Sql\Ddl;
 use Zend\Db\Sql\Sql;
+use Zend\ServiceManager\ServiceLocatorAwareInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
 use ZfSimpleMigrations\Library\OutputWriter;
 use ZfSimpleMigrations\Model\MigrationVersion;
 use ZfSimpleMigrations\Model\MigrationVersionTable;
 
 /**
  * Main migration logic
  */
-class Migration
+class Migration implements ServiceLocatorAwareInterface
 {
     protected $migrationsDir;
     protected $migrationsNamespace;
@@ -28,6 +30,10 @@ class Migration
     protected $migrationVersionTable;
     protected $outputWriter;
 
+    /**
+     * @var ServiceLocatorInterface
+     */
+    protected $serviceLocator;
     /**
      * @param \Zend\Db\Adapter\Adapter $adapter
      * @param array $config
@@ -247,6 +253,19 @@ protected function applyMigration(array $migration, $down = false, $fake = false
             /** @var $migrationObject AbstractMigration */
             $migrationObject = new $migration['class']($this->metadata, $this->outputWriter);
 
+            if ($migrationObject instanceof ServiceLocatorAwareInterface) {
+                if (is_null($this->serviceLocator)) {
+                    throw new \RuntimeException(
+                        sprintf(
+                            'Migration class %s requires a ServiceLocator, but it is no instance available.',
+                            get_class($migrationObject)
+                        )
+                    );
+                }
+
+                $migrationObject->setServiceLocator($this->serviceLocator);
+            }
+
             $this->outputWriter->writeLine(sprintf("%sExecute migration class %s %s",
                 $fake ? '[FAKE] ' : '', $migration['class'], $down ? 'down' : 'up'));
 
@@ -274,4 +293,27 @@ protected function applyMigration(array $migration, $down = false, $fake = false
             throw new MigrationException($msg);
         }
     }
+
+    /**
+     * Set service locator
+     *
+     * @param ServiceLocatorInterface $serviceLocator
+     * @return mixed
+     */
+    public function setServiceLocator(ServiceLocatorInterface $serviceLocator)
+    {
+        $this->serviceLocator = $serviceLocator;
+
+        return $this;
+    }
+
+    /**
+     * Get service locator
+     *
+     * @return ServiceLocatorInterface
+     */
+    public function getServiceLocator()
+    {
+        return $this->serviceLocator;
+    }
 }