Phossa2\Query\Traits\Clause\UnionTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	union()	0	5	1
A	unionAll()	0	5	1
A	getStatement()	0	19	2
A	buildUnion()	0	13	3
A	setPrevious()	0	5	1
A	hasPrevious()	0	4	1
A	getPrevious()	0	4	1
	getBuilder()	0	1	?
	combineSettings()	0	1	?
	buildSql()	0	1	?
	bindValues()	0	1	?

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Query
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Query\Traits\Clause;

use Phossa2\Query\Interfaces\BuilderInterface;
use Phossa2\Query\Interfaces\Clause\UnionInterface;
use Phossa2\Query\Interfaces\Statement\SelectStatementInterface;

/**
 * UnionTrait
 *
 * Implementation of UnionInterface
 *
 * @package Phossa2\Query
 * @author  Hong Zhang <phossa@126.com>
 * @see     UnionInterface
 * @version 2.0.0
 * @since   2.0.0 added
 */
trait UnionTrait
{
    /**
     * 0 NO, 1 YES, 2 UNION ALL
     * @var    int
     * @access protected
     */
    protected $is_union = UnionInterface::UNION_NOT;

    /**
     * Previous statement used in UNION/UNION ALL
     *
     * @var    SelectStatementInterface
     * @access protected
     */
    protected $previous;

    /**
     * {@inheritDoc}
     */
    public function union()/*# : SelectStatementInterface */
    {
        $this->is_union = UnionInterface::UNION_YES;
        return $this->getBuilder()->select()->table('')->setPrevious($this);
    }

    /**
     * {@inheritDoc}
     */
    public function unionAll()/*# : SelectStatementInterface */
    {
        $this->is_union = UnionInterface::UNION_ALL;
        return $this->getBuilder()->select()->table('')->setPrevious($this);
    }

    /**
     * Override `getStatement()` in StatementAbstract
     *
     * {@inheritDoc}
     */
    public function getStatement(array $settings = [])/*# : string */
    {
        // combine settings
        $settings = $this->combineSettings($settings);

        // statements
        $sql = [];

        // build previous statement
        if ($this->hasPrevious()) {
            $sql[] = $this->getPrevious()->getStatement($settings);
        }

        // build current sql
        $sql[] = $this->buildSql($settings);

        // replace with ?, :name or real values
        return $this->bindValues(join($settings['seperator'], $sql), $settings);
    }

    /**
     * Build UNION/UNION ALL
     *
     * @param  string $prefix
     * @param  array $settings
     * @return string
     * @access protected
     */
    protected function buildUnion(
        /*# string */ $prefix,
        array $settings
    )/*# : string */ {
        switch ($this->is_union) {
            case UnionInterface::UNION_YES :

There must be no space before the colon in a CASE statement

                return $settings['seperator'] . 'UNION';
            case UnionInterface::UNION_ALL :

There must be no space before the colon in a CASE statement

                return $settings['seperator'] . 'UNION ALL';
            default :

There must be no space before the colon in a DEFAULT statement

                return $prefix;
        }
    }

    /**
     * Set previous SELECT
     *
     * @param  SelectStatementInterface $select
     * @return $this
     * @access protected
     */
    protected function setPrevious(SelectStatementInterface $select)
    {
        $this->previous = $select;
        return $this;
    }

    /**
     * Has previous SELECT ?
     *
     * @return bool
     * @access protected
     */
    protected function hasPrevious()/*# : bool */
    {
        return null !== $this->previous;
    }

    /**
     * Get previous SELECT
     *
     * @return SelectStatementInterface
     * @access protected
     */
    protected function getPrevious()/*# : SelectStatementInterface */
    {
        return $this->previous;
    }

    /**
     * Return the builder
     *
     * @return BuilderInterface
     * @access public
     */
    abstract public function getBuilder()/*# : BuilderInterface */;
    abstract protected function combineSettings(array $settings)/*# : array */;
    abstract protected function buildSql(array $settings)/*# : string */;
    abstract protected function bindValues(/*# string */ $sql, array $settings)/*# : string */;
}