Spiral\Database\Schemas\Prototypes\AbstractElement

Complexity

Total Complexity

9

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	getTable()	0	4	1
A	setName()	0	6	1
A	getName()	0	8	2
A	isDeclared()	0	4	1
A	declared()	0	6	1
	sqlStatement()	0	1	?
A	__toString()	0	4	1
	resolveSchema()	0	1	?

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Database\Schemas\Prototypes;

use Spiral\Database\Schemas\AbstractTable;
use Spiral\Database\Exceptions\SchemaException;

/**
 * Aggregates common functionality for columns, indexes and foreign key schemas.
 */
abstract class AbstractElement
{
    /**
     * Declaration flag used to create full table diff.
     *
     * @var bool
     */
    protected $declared = false;

    /**
     * Element name.
     *
     * @var string
     */
    protected $name = '';

    /**
     * @invisible
     *
     * @var AbstractTable
     */
    protected $table = null;

    /**
     * @param AbstractTable $table
     * @param string        $name
     * @param mixed         $schema Driver specific schema information.
     */
    public function __construct(AbstractTable $table, $name, $schema = null)
    {
        $this->name = $name;
        $this->table = $table;

        if (!empty($schema)) {
            $this->resolveSchema($schema);
        }
    }

    /**
     * Associated table.
     *
     * @return AbstractTable
     */
    public function getTable()
    {
        return $this->table;
    }

    /**
     * Set element name.
     *
     * @param string $name
     *
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Get element name. Can automatically quote such name.
     *
     * @param bool $quoted
     *
     * @return string
     */
    public function getName($quoted = false)
    {
        if ($quoted) {
            return $this->table->driver()->identifier($this->name);
        }

        return $this->name;
    }

    /**
     * @return bool
     */
    public function isDeclared()
    {
        return $this->declared;
    }

    /**
     * Mark schema entity as declared, it will be kept in final diff.
     *
     * @param bool $declared
     *
     * @return $this
     */
    public function declared($declared = true)
    {
        $this->declared = $declared;

        return $this;
    }

    /**
     * Element creation/definition syntax.
     *
     * @return string
     */
    abstract public function sqlStatement();

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->sqlStatement();
    }

    /**
     * Parse driver specific schema information and populate element data.
     *
     * @param mixed $schema
     *
     * @throws SchemaException
     */
    abstract protected function resolveSchema($schema);
}