Kumbia\ActiveRecord\Metadata\Metadata

Complexity

Total Complexity

16

Size/Duplication

Total Lines	189
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes	5
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
B	getMetadata()	0	23	4
A	filterCol()	0	10	4
	queryFields()	0	1	?
A	getFields()	0	4	1
A	getFieldsList()	0	4	1
A	getPK()	0	4	1
A	getWithDefault()	0	4	1
A	getAutoFields()	0	4	1
A	__construct()	0	5	1
A	get()	0	8	2

<?php

/**
 * KumbiaPHP web & app Framework.
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://wiki.kumbiaphp.com/Licencia
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@kumbiaphp.com so we can send you a copy immediately.
 *
 * @category   Kumbia
 *
 * @copyright  2005 - 2016  Kumbia Team (http://www.kumbiaphp.com)
 * @license    http://wiki.kumbiaphp.com/Licencia     New BSD License
 */
namespace Kumbia\ActiveRecord\Metadata;

/**
 * Metadata de tabla.
 */
abstract class Metadata
{
    /**
     * Singleton de metadata.
     *
     * @var array
     */
    private static $instances = [];

    /**
     * Descripción de los campos.
     *
     * @var array
     */
    protected $fields = [];

    /**
     * Lista de campos.
     *
     * @var array
     */
    protected $fieldsList = [];

    /**
     * Clave primaria.
     *
     * @var string
     */
    protected $pk;

    /**
     * Campos con valor predeterminado.
     *
     * @var array
     */
    protected $withDefault = [];

    /**
     * Campos con valor autogenerado.
     *
     * @var array
     */
    protected $autoFields = [];

    /**
     * Metadata de la tabla.
     *
     * @param string $type     tipo de controlador
     * @param string $database
     * @param string $table
     * @param string $schema
     *
     * @return Metadata
     */
    public static function get($type, $database, $table, $schema = null)
    {
        if (isset(self::$instances["$database.$table.$schema"])) {
            return self::$instances["$database.$table.$schema"];
        }

        return self::getMetadata($type, $database, $table, $schema);
    }

    /**
     * Obtiene la metadata de la tabla
     * Y la cachea si esta en producción.
     *
     * @param string $type     tipo de controlador
     * @param string $database
     * @param string $table
     * @param string $schema
     *
     * @return Metadata
     */
    private static function getMetadata($type, $database, $table, $schema)
    {
        if (PRODUCTION && !(self::$instances["$database.$table.$schema"] = \Cache::driver()->get("$database.$table.$schema", 'ActiveRecord.Metadata'))) {
            return self::$instances["$database.$table.$schema"];
        }
        $class = ucwords($type).'Metadata';

        $class = __NAMESPACE__."\\$class";

        self::$instances["$database.$table.$schema"] = new $class($database, $table, $schema);

         // Cachea los metadatos
        if (PRODUCTION) {
            \Cache::driver()->save(
                self::$instances["$database.$table.$schema"],
                \Config::get('config.application.metadata_lifetime'),
                "$database.$table.$schema",
                'ActiveRecord.Metadata'
            );
        }

        return self::$instances["$database.$table.$schema"];
    }

    /**
     * Constructor.
     *
     * @param string $database base de datos
     * @param string $table    tabla
     * @param string $schema   squema
     */
    private function __construct($database, $table, $schema = null)
    {
        $this->fields = $this->queryFields($database, $table, $schema);
        $this->fieldsList = \array_keys($this->fields);
    }

    /**
     * Permite el filtrado de columna en PK, por Defecto y Autogenerado.
     *
     * @param $m información de la columna
     * @param $field nombre de la columna
     */
    protected function filterCol($m, $field)
    {
        if ($m['Key'] == 'PRI') {
            $this->pk = $field;
        } elseif ($m['Default']) {
            $this->withDefault[] = $field;
        } elseif ($m['Auto']) {
            $this->autoFields[] = $field;
        }
    }

    /**
     * Consultar los campos de la tabla en la base de datos.
     *
     * @param string $database base de datos
     * @param string $table    tabla
     * @param string $schema   squema
     *
     * @return array
     */
    abstract protected function queryFields($database, $table, $schema = null);

    /**
     * Obtiene la descripción de los campos.
     *
     * @return array
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Obtiene la lista de campos.
     *
     * @return array
     */
    public function getFieldsList()
    {
        return $this->fieldsList;
    }

    /**
     * Obtiene la clave primaria.
     *
     * @return string
     */
    public function getPK()
    {
        return $this->pk;
    }

    /**
     * Obtiene los campos con valor predeterminado.
     *
     * @return array
     */
    public function getWithDefault()
    {
        return $this->withDefault;
    }

    /**
     * Obtiene los campos con valor generado automatico.
     *
     * @return array
     */
    public function getAutoFields()
    {
        return $this->autoFields;
    }
}