123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149 |
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the LGPL. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\DBAL\Migrations\Configuration;
- use Doctrine\DBAL\Migrations\MigrationException;
- /**
- * Abstract Migration Configuration class for loading configuration information
- * from a configuration file (xml or yml).
- *
- * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @link www.doctrine-project.org
- * @since 2.0
- * @author Jonathan H. Wage <jonwage@gmail.com>
- */
- abstract class AbstractFileConfiguration extends Configuration
- {
- /**
- * The configuration file used to load configuration information
- *
- * @var string
- */
- private $file;
- /**
- * Whether or not the configuration file has been loaded yet or not
- *
- * @var boolean
- */
- private $loaded = false;
- /**
- * @var array of possible configuration properties in migrations configuration.
- */
- private $configurationProperties = [
- 'migrations_namespace' => 'setMigrationsNamespace',
- 'table_name' => 'setMigrationsTableName',
- 'column_name' => 'setMigrationsColumnName',
- 'organize_migrations' => 'setMigrationOrganisation',
- 'name' => 'setName',
- 'migrations_directory' => 'loadMigrationsFromDirectory',
- 'migrations' => 'loadMigrations',
- ];
- protected function setConfiguration(array $config)
- {
- foreach($config as $configurationKey => $configurationValue) {
- if (!isset($this->configurationProperties[$configurationKey])) {
- $msg = sprintf('Migrations configuration key "%s" does not exists.', $configurationKey);
- throw MigrationException::configurationNotValid($msg);
- }
- }
- foreach($this->configurationProperties as $configurationKey => $configurationSetter) {
- if (isset($config[$configurationKey])) {
- $this->{$configurationSetter}($config[$configurationKey]);
- }
- }
- }
- private function loadMigrationsFromDirectory($migrationsDirectory)
- {
- $this->setMigrationsDirectory($migrationsDirectory);
- $this->registerMigrationsFromDirectory($migrationsDirectory);
- }
- private function loadMigrations($migrations)
- {
- if (is_array($migrations)) {
- foreach ($migrations as $migration) {
- $this->registerMigration($migration['version'], $migration['class']);
- }
- }
- }
- private function setMigrationOrganisation($migrationOrganisation)
- {
- if (strcasecmp($migrationOrganisation, static::VERSIONS_ORGANIZATION_BY_YEAR) == 0) {
- $this->setMigrationsAreOrganizedByYear();
- } else if (strcasecmp($migrationOrganisation, static::VERSIONS_ORGANIZATION_BY_YEAR_AND_MONTH) == 0) {
- $this->setMigrationsAreOrganizedByYearAndMonth();
- } else {
- $msg = 'Unknown ' . var_export($migrationOrganisation, true) . ' for configuration "organize_migrations".';
- throw MigrationException::configurationNotValid($msg);
- }
- }
- /**
- * Load the information from the passed configuration file
- *
- * @param string $file The path to the configuration file
- *
- * @throws MigrationException Throws exception if configuration file was already loaded
- */
- public function load($file)
- {
- if ($this->loaded) {
- throw MigrationException::configurationFileAlreadyLoaded();
- }
- if (file_exists($path = getcwd() . '/' . $file)) {
- $file = $path;
- }
- $this->file = $file;
- if (!file_exists($file)) {
- throw new \InvalidArgumentException('Given config file does not exist');
- }
- $this->doLoad($file);
- $this->loaded = true;
- }
- protected function getDirectoryRelativeToFile($file, $input)
- {
- $path = realpath(dirname($file) . '/' . $input);
- return ($path !== false) ? $path : $input;
- }
- public function getFile()
- {
- return $this->file;
- }
- /**
- * Abstract method that each file configuration driver must implement to
- * load the given configuration file whether it be xml, yaml, etc. or something
- * else.
- *
- * @param string $file The path to a configuration file.
- */
- abstract protected function doLoad($file);
- }
|