Repo2\QueryBuilder\Expression\Column

Complexity

Total Complexity

15

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	3

11 Methods

Rating	Name	Duplication	Size	Complexity
A	integer()	0	4	1
A	varchar()	0	4	1
A	bigint()	0	4	1
A	timestamp()	0	4	1
A	type()	0	5	1
A	required()	0	5	1
A	defval()	0	5	1
A	primary()	0	5	1
A	compile()	0	11	3
A	compilePrimary()	0	4	1
A	compileRegular()	0	10	3

<?php

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Repo2
 *
 * 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.
 */

namespace Repo2\QueryBuilder\Expression;

use Repo2\QueryBuilder\DDL\DataType;
use Repo2\QueryBuilder\DriverInterface;
use Repo2\QueryBuilder\Exception\CompileException;

class Column extends Reference
{
    /** @var DataType */
    private $type;

    /** @var boolean */
    private $nullable = true;

    /** @var string */
    private $defval;

    /** @var boolean */
    private $primary = false;

    /**
     * @return Column
     */
    public function integer()
    {
        return $this->type(new DataType\Scalar('integer'));
    }

    /**
     * @param int $length
     * @return Column
     */
    public function varchar($length)
    {
        return $this->type(new DataType\ScalarLength('varchar', $length));
    }

    /**
     * @return Column
     */
    public function bigint()
    {
        return $this->type(new DataType\Scalar('bigint'));
    }

    /**
     * @return Column
     */
    public function timestamp()
    {
        return $this->type(new DataType\Scalar('timestamp'));
    }

    /**
     * @param DataType $type
     * @return Column
     */
    public function type(DataType $type)
    {
        $this->type = $type;
        return $this;
    }

    /**
     * Set NOT NULL option.
     *
     * @return Column
     */
    public function required()
    {
        $this->nullable = false;
        return $this;
    }

    /**
     * Set default value.
     *
     * @param mixed $val
     * @return Column
     */
    public function defval($val)
    {
        $this->defval = $val;
        return $this;
    }

    /**
     * Defines the column as primary key.
     *
     * @return Column
     */
    public function primary()
    {
        $this->primary = true;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function compile(DriverInterface $driver)
    {
        if (!$this->type) {
            throw new CompileException(sprintf('Data type for the column "%s" not defined.', $this->ref));
        }
        $compiled = parent::compile($driver) . ' ' . $this->type->compile();
        if ($this->primary) {
            return $this->compilePrimary($compiled);
        }
        return $this->compileRegular($driver, $compiled);
    }

    /**
     * @param string $compiled
     * @return string
     */
    private function compilePrimary($compiled)
    {
        return $compiled . ' PRIMARY KEY';
    }

    /**
     * @param DriverInterface $driver
     * @param string $compiled
     * @return string
     */
    private function compileRegular(DriverInterface $driver, $compiled)
    {
        if (!$this->nullable) {
            $compiled .= ' NOT NULL';
        }
        if (null !== $this->defval) {
            $compiled .= ' DEFAULT "' . $driver->escapeValue($this->defval) . '"';
        }
        return $compiled;
    }
}