Soluble\Schema\Source\MysqlInformationSchema

Complexity

Total Complexity

36

Size/Duplication

Total Lines	271
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

82.22%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndexesInformation()	0	6	1
A	getPrimaryKey()	0	10	2
A	getColumnsInformation()	0	6	1
A	getForeignKeys()	0	6	1
A	getReferences()	0	6	1
A	getTablesInformation()	0	6	1
A	__construct()	0	15	3
A	getUniqueKeys()	0	17	4
A	getPrimaryKeys()	0	10	2
C	getTableConfig()	0	28	7
B	getSchemaConfig()	0	21	6
A	loadCacheInformation()	0	16	4
A	clearCacheInformation()	0	10	3

<?php

namespace Soluble\Schema\Source;

use Soluble\Schema\Exception;
use Soluble\Schema\Source;
use Soluble\DbWrapper\Adapter\AdapterInterface;
use Soluble\DbWrapper\AdapterFactory;
use ArrayObject;

class MysqlInformationSchema extends Source\AbstractSchemaSource
{
    /**
     * Schema name.
     *
     * @var string
     */
    protected $schema;

    /**
     * Whether to include full schema options like comment, collations...
     *
     * @var bool
     */
    protected $include_options = true;

    /**
     * @var array
     */
    protected static $localCache = [];

    /**
     * @var bool
     */
    protected $useLocalCaching = true;

    /**
     * @var array
     */
    protected static $fullyCachedSchemas = [];

    /**
     * @var Mysql\MysqlDriverInterface
     */
    protected $driver;

    /**
     * Constructor.
     *
     * @param \PDO|\mysqli|AdapterInterface $adapter
     * @param string|null                   $schema  default schema, taken from adapter if not given
     *
     * @throws Exception\InvalidArgumentException for invalid connection
     * @throws Exception\InvalidUsageException    thrown if no schema can be found
     */
    public function __construct($adapter, $schema = null)
    {
        if (!$adapter instanceof AdapterInterface) {
            try {
                $adapter = AdapterFactory::createAdapterFromResource($adapter);
            } catch (Exception\InvalidArgumentException $e) {
                $msg = "MysqlInformationSchema requires a valid 'mysqli', 'pdo:mysql' or AdapterInterface parameter ({$e->getMessage()}).";
                throw new Exception\InvalidArgumentException($msg);
            }
        }

        parent::__construct($adapter, $schema);

        $this->driver = new Mysql\MysqlDriver51($this->adapter, $this->schema);
    }

    /**
     * {@inheritdoc}
     */
    public function getUniqueKeys($table, $include_primary = false)
    {
        $this->loadCacheInformation($table);
        $uniques = (array) self::$localCache[$this->schemaSignature]['tables'][$table]['unique_keys'];
        if ($include_primary) {
            try {
                $pks = $this->getPrimaryKeys($table);
                if (count($pks) > 0) {
                    $uniques = array_merge($uniques, ['PRIMARY' => $pks]);
                }
            } catch (Exception\NoPrimaryKeyException $e) {
                // Ignore exception
            }
        }

        return $uniques;
    }

    /**
     * {@inheritdoc}
     */
    public function getIndexesInformation($table)
    {
        $this->loadCacheInformation($table);

        return self::$localCache[$this->schemaSignature]['tables'][$table]['indexes'];
    }

    /**
     * {@inheritdoc}
     */
    public function getPrimaryKey($table)
    {
        $pks = $this->getPrimaryKeys($table);
        if (count($pks) > 1) {
            $keys = implode(',', $pks);
            throw new Exception\MultiplePrimaryKeyException(__METHOD__ . ". Multiple primary keys found on table '{$this->schemaSignature}'.'$table':  $keys");
        }

        return $pks[0];
    }

    /**
     * {@inheritdoc}
     */
    public function getPrimaryKeys($table)
    {
        $this->loadCacheInformation($table);
        $pks = self::$localCache[$this->schemaSignature]['tables'][$table]['primary_keys'];
        if (count($pks) == 0) {
            throw new Exception\NoPrimaryKeyException(__METHOD__ . ". No primary keys found on table  '{$this->schemaSignature}'.'$table'.");
        }

        return $pks;
    }

    /**
     * {@inheritdoc}
     */
    public function getColumnsInformation($table)
    {
        $this->loadCacheInformation($table);

        return self::$localCache[$this->schemaSignature]['tables'][$table]['columns'];
    }

    /**
     * {@inheritdoc}
     */
    public function getForeignKeys($table)
    {
        $this->loadCacheInformation($table);

        return self::$localCache[$this->schemaSignature]['tables'][$table]['foreign_keys'];
    }

    /**
     * {@inheritdoc}
     */
    public function getReferences($table)
    {
        $this->loadCacheInformation($table);

        return self::$localCache[$this->schemaSignature]['tables'][$table]['references'];
    }

    /**
     * {@inheritdoc}
     */
    public function getTablesInformation()
    {
        $this->loadCacheInformation(null);

        return self::$localCache[$this->schemaSignature]['tables'];
    }

    /**
     * Get a table configuration.
     *
     * @throws Exception\ErrorException
     * @throws Exception\TableNotFoundException
     *
     * @param string    $table           table name
     * @param bool|null $include_options include extended information
     *
     * @return ArrayObject
     */
    protected function getTableConfig($table, $include_options = null)
    {
        if ($include_options === null) {
            $include_options = $this->include_options;
        }

        $schema = $this->schemaSignature;

        if ($this->useLocalCaching &&
                isset(self::$localCache[$schema]['tables'][$table])) {
            return self::$localCache[$schema]['tables'][$table];
        }

        $config = $this->driver->getSchemaConfig($table, $include_options);

        if (!array_key_exists($table, $config['tables'])) {
            throw new Exception\TableNotFoundException(__METHOD__ . ". Table '$table' in database schema '{$schema}' not found.");
        }

        if ($this->useLocalCaching) {
            if (!array_key_exists($schema, self::$localCache)) {
                self::$localCache[$schema] = [];
            }
            self::$localCache[$schema] = new ArrayObject(array_merge_recursive((array) self::$localCache[$schema], (array) $config));
        }

        return $config['tables'][$table];
    }

    /**
     * Get schema configuration.
     *
     * @throws Exception\ErrorException
     * @throws Exception\SchemaNotFoundException
     *
     * @param bool|null $include_options include extended information
     *
     * @return ArrayObject
     */
    public function getSchemaConfig($include_options = null)
    {
        if ($include_options === null) {
            $include_options = $this->include_options;
        }
        $schema = $this->schemaSignature;
        if ($this->useLocalCaching && in_array($schema, self::$fullyCachedSchemas)) {
            return self::$localCache[$schema];
        }

        $config = $this->driver->getSchemaConfig($table = null, $include_options);
        if (count($config['tables']) == 0) {
            throw new Exception\SchemaNotFoundException(__METHOD__ . " Error: schema '{$schema}' not found or without any table or view");
        }
        if ($this->useLocalCaching) {
            self::$localCache[$schema] = $config;
            self::$fullyCachedSchemas[] = $schema;
        }

        return $config;
    }

    /**
     * @param string $table
     *
     * @throws Exception\InvalidArgumentException
     * @throws Exception\TableNotFoundException
     */
    protected function loadCacheInformation($table = null)
    {
        $schema = $this->schema;
        $this->checkTableArgument($table);

        if (!in_array($schema, self::$fullyCachedSchemas)) {
            if ($table !== null) {
                $this->getTableConfig($table);
            } else {
                $this->getSchemaConfig();
            }
        } elseif ($table !== null) {
            // Just in case to check if table exists
            $this->getTableConfig($table);
        }
    }

    /**
     * Clear local cache information for the current schema.
     *
     * @throws Exception\InvalidArgumentException
     */
    public function clearCacheInformation()
    {
        $schema = $this->schema;
        if (array_key_exists($schema, self::$localCache)) {
            unset(self::$localCache[$schema]);
            if (($key = array_search($schema, self::$fullyCachedSchemas)) !== false) {
                unset(self::$fullyCachedSchemas[$key]);
            }
        }
    }
}