<?php
/**
* Phinx
*
* (The MIT license)
* Copyright (c) 2015 Rob Morgan
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated * documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*
* @package Phinx
* @subpackage Phinx\Config
*/
namespace Phinx\Config;
use Symfony\Component\Yaml\Yaml;
/**
* Phinx configuration class.
*
* @package Phinx
* @author Rob Morgan
*/
class Config implements ConfigInterface
{
/**
* @var array
*/
private $values = array();
/**
* @var string
*/
protected $configFilePath;
/**
* {@inheritdoc}
*/
public function __construct(array $configArray, $configFilePath = null)
{
$this->configFilePath = $configFilePath;
$this->values = $this->replaceTokens($configArray);
}
/**
* Create a new instance of the config class using a Yaml file path.
*
* @param string $configFilePath Path to the Yaml File
* @throws \RuntimeException
* @return Config
*/
public static function fromYaml($configFilePath)
{
$configFile = file_get_contents($configFilePath);
$configArray = Yaml::parse($configFile);
if (!is_array($configArray)) {
throw new \RuntimeException(sprintf(
'File \'%s\' must be valid YAML',
$configFilePath
));
}
return new static($configArray, $configFilePath);
}
/**
* Create a new instance of the config class using a JSON file path.
*
* @param string $configFilePath Path to the JSON File
* @throws \RuntimeException
* @return Config
*/
public static function fromJson($configFilePath)
{
$configArray = json_decode(file_get_contents($configFilePath), true);
if (!is_array($configArray)) {
throw new \RuntimeException(sprintf(
'File \'%s\' must be valid JSON',
$configFilePath
));
}
return new static($configArray, $configFilePath);
}
/**
* Create a new instance of the config class using a PHP file path.
*
* @param string $configFilePath Path to the PHP File
* @throws \RuntimeException
* @return Config
*/
public static function fromPhp($configFilePath)
{
ob_start();
/** @noinspection PhpIncludeInspection */
$configArray = include($configFilePath);
// Hide console output
ob_end_clean();
if (!is_array($configArray)) {
throw new \RuntimeException(sprintf(
'PHP file \'%s\' must return an array',
$configFilePath
));
}
return new static($configArray, $configFilePath);
}
/**
* {@inheritdoc}
*/
public function getEnvironments()
{
if (isset($this->values) && isset($this->values['environments'])) {
$environments = array();
foreach ($this->values['environments'] as $key => $value) {
if (is_array($value)) {
$environments[$key] = $value;
}
}
return $environments;
}
return null;
}
/**
* {@inheritdoc}
*/
public function getEnvironment($name)
{
$environments = $this->getEnvironments();
if (isset($environments[$name])) {
if (isset($this->values['environments']['default_migration_table'])) {
$environments[$name]['default_migration_table'] =
$this->values['environments']['default_migration_table'];
}
return $environments[$name];
}
return null;
}
/**
* {@inheritdoc}
*/
public function hasEnvironment($name)
{
return (null !== $this->getEnvironment($name));
}
/**
* {@inheritdoc}
*/
public function getDefaultEnvironment()
{
// The $PHINX_ENVIRONMENT variable overrides all other default settings
$env = getenv('PHINX_ENVIRONMENT');
if (!empty($env)) {
if ($this->hasEnvironment($env)) {
return $env;
}
throw new \RuntimeException(sprintf(
'The environment configuration (read from $PHINX_ENVIRONMENT) for \'%s\' is missing',
$env
));
}
// if the user has configured a default database then use it,
// providing it actually exists!
if (isset($this->values['environments']['default_database'])) {
if ($this->getEnvironment($this->values['environments']['default_database'])) {
return $this->values['environments']['default_database'];
}
throw new \RuntimeException(sprintf(
'The environment configuration for \'%s\' is missing',
$this->values['environments']['default_database']
));
}
// else default to the first available one
if (is_array($this->getEnvironments()) && count($this->getEnvironments()) > 0) {
$names = array_keys($this->getEnvironments());
return $names[0];
}
throw new \RuntimeException('Could not find a default environment');
}
/**
* Get the aliased value from a supplied alias.
*
* @param string $alias
*
* @return string|null
*/
public function getAlias($alias){
return !empty($this->values['aliases'][$alias]) ? $this->values['aliases'][$alias] : null;
}
/**
* {@inheritdoc}
*/
public function getConfigFilePath()
{
return $this->configFilePath;
}
/**
* {@inheritdoc}
*/
public function getMigrationPath()
{
if (!isset($this->values['paths']['migrations'])) {
throw new \UnexpectedValueException('Migrations path missing from config file');
}
return $this->values['paths']['migrations'];
}
/**
* Gets the base class name for migrations.
*
* @param boolean $dropNamespace Return the base migration class name without the namespace.
* @return string
*/
public function getMigrationBaseClassName($dropNamespace = true)
{
$className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class'];
return $dropNamespace ? substr(strrchr($className, '\\'), 1) ?: $className : $className;
}
/**
* {@inheritdoc}
*/
public function getSeedPath()
{
if (!isset($this->values['paths']['seeds'])) {
throw new \UnexpectedValueException('Seeds path missing from config file');
}
return $this->values['paths']['seeds'];
}
/**
* Get the template file name.
*
* @return string|false
*/
public function getTemplateFile()
{
if (!isset($this->values['templates']['file'])) {
return false;
}
return $this->values['templates']['file'];
}
/**
* Get the template class name.
*
* @return string|false
*/
public function getTemplateClass()
{
if (!isset($this->values['templates']['class'])) {
return false;
}
return $this->values['templates']['class'];
}
/**
* Replace tokens in the specified array.
*
* @param array $arr Array to replace
* @return array
*/
protected function replaceTokens(array $arr)
{
// Get environment variables
// $_ENV is empty because variables_order does not include it normally
$tokens = array();
foreach ($_SERVER as $varname => $varvalue) {
if (0 === strpos($varname, 'PHINX_')) {
$tokens['%%' . $varname . '%%'] = $varvalue;
}
}
// Phinx defined tokens (override env tokens)
$tokens['%%PHINX_CONFIG_PATH%%'] = $this->getConfigFilePath();
$tokens['%%PHINX_CONFIG_DIR%%'] = dirname($this->getConfigFilePath());
// Recurse the array and replace tokens
return $this->recurseArrayForTokens($arr, $tokens);
}
/**
* Recurse an array for the specified tokens and replace them.
*
* @param array $arr Array to recurse
* @param array $tokens Array of tokens to search for
* @return array
*/
protected function recurseArrayForTokens($arr, $tokens)
{
$out = array();
foreach ($arr as $name => $value) {
if (is_array($value)) {
$out[$name] = $this->recurseArrayForTokens($value, $tokens);
continue;
}
if (is_string($value)) {
foreach ($tokens as $token => $tval) {
$value = str_replace($token, $tval, $value);
}
$out[$name] = $value;
continue;
}
$out[$name] = $value;
}
return $out;
}
/**
* {@inheritdoc}
*/
public function offsetSet($id, $value)
{
$this->values[$id] = $value;
}
/**
* {@inheritdoc}
*/
public function offsetGet($id)
{
if (!array_key_exists($id, $this->values)) {
throw new \InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id));
}
return $this->values[$id] instanceof \Closure ? $this->values[$id]($this) : $this->values[$id];
}
/**
* {@inheritdoc}
*/
public function offsetExists($id)
{
return isset($this->values[$id]);
}
/**
* {@inheritdoc}
*/
public function offsetUnset($id)
{
unset($this->values[$id]);
}
}