Phossa2\Query\Traits\Clause\ColTrait

Complexity

Total Complexity

22

Size/Duplication

Total Lines	177
Duplicated Lines	2.82 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	col()	0	4	1
A	distinct()	0	5	2
A	count()	0	4	1
A	min()	0	4	1
A	max()	0	4	1
A	avg()	0	4	1
A	sum()	0	4	1
A	colTpl()	0	7	1
A	colRaw()	0	4	1
A	realCol()	0	20	4
A	multipleCol()	0	10	3
A	buildCol()	5	17	3
A	buildDistinct()	0	4	2
	isRaw()	0	1	?
	quoteAlias()	0	1	?
	quoteItem()	0	1	?
	clauseTpl()	0	1	?
	getClause()	0	1	?
	joinClause()	0	6	?

<?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\Clause\ColInterface;

/**
 * ColTrait
 *
 * Implementation of ColInterface
 *
 * @package Phossa2\Query
 * @author  Hong Zhang <phossa@126.com>
 * @see     ColInterface
 * @version 2.0.0
 * @since   2.0.0 added
 */
trait ColTrait
{
    /**
     * @var    bool
     * @access protected
     */
    protected $is_distinct = false;

    /**
     * {@inheritDoc}
     */
    public function col($col, /*# string */ $alias = '')
    {
        return $this->realCol($col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function distinct($col = '', /*# string */ $alias = '')
    {
        $this->is_distinct = true;
        return empty($col) ? $this : $this->col($col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function count(/*# string */ $col, /*# string */ $alias = '')
    {
        return $this->colTpl('COUNT(%s)', $col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function min(/*# string */ $col, /*# string */ $alias = '')
    {
        return $this->colTpl('MIN(%s)', $col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function max(/*# string */ $col, /*# string */ $alias = '')
    {
        return $this->colTpl('MAX(%s)', $col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function avg(/*# string */ $col, /*# string */ $alias = '')
    {
        return $this->colTpl('AVG(%s)', $col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function sum(/*# string */ $col, /*# string */ $alias = '')
    {
        return $this->colTpl('SUM(%s)', $col, $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function colTpl(
        /*# string */ $template,
        $col,
        /*# string */ $alias = ''
    ) {
        return $this->colRaw($this->clauseTpl($template, $col), $alias);
    }

    /**
     * {@inheritDoc}
     */
    public function colRaw($rawString, /*# string */ $alias = '')
    {
        return $this->realCol($rawString, $alias, true);
    }

    /**
     * @param  mixed $col column/field specification[s]
     * @param  string $alias column alias name
     * @param  bool $rawMode raw mode
     */
    protected function realCol(
        $col,
        /*# string */ $alias = '',
        $rawMode = false
    ) {
        if (empty($col)) {
            return $this;
        } elseif (is_array($col)) {
            $this->multipleCol($col, $rawMode);
        } else {
            $clause = &$this->getClause('COL');
            $raw = $this->isRaw($col, $rawMode);
            if ('' === $alias) {
                $clause[] = [$col, $raw];
            } else {
                $clause[(string) $alias] = [$col, $raw];
            }
        }
        return $this;
    }

    /**
     * from multiple tables
     *
     * @param  array $cols
     * @param  bool $rawMode
     * @access protected
     */
    protected function multipleCol(array $cols, /*# bool */ $rawMode)
    {
        foreach ($cols as $key => $val) {
            if (is_int($key)) {
                $this->realCol($val, '', $rawMode);
            } else {
                $this->realCol($key, $val, $rawMode);
            }
        }
    }

    /**
     * Build fields
     *
     * @param  array $settings
     * @return string
     * @access protected
     */
    protected function buildCol(array $settings)/*# : string */
    {
        $result = [];
        $clause = &$this->getClause('COL');

        if (empty($clause)) {
            $result[] = '*';
        } else {
            foreach ($clause as $as => $col) {

This code seems to be duplicated across your project.

                $alias = $this->quoteAlias($as);
                $field = $this->quoteItem($col[0], $col[1]);
                $result[] = $field . $alias;
            }
        }

        return $this->joinClause('', ',', $result, $settings);
    }

    /**
     * Build DISTINCT
     *
     * @param  array $settings
     * @return string
     * @access protected
     */
    protected function buildDistinct(array $settings)/*# : string */

The parameter $settings is not used and could be removed.

    {
        return $this->is_distinct ? ' DISTINCT' : '';
    }

    abstract protected function isRaw($str, /*# bool */ $rawMode)/*# : bool */;
    abstract protected function quoteAlias($alias)/*# : string */;
    abstract protected function quoteItem($item, /*# bool */ $rawMode = false)/*# : string */;
    abstract protected function clauseTpl(/*# string */ $template, $col)/*# : string */;
    abstract protected function &getClause(/*# string */ $clauseName)/*# : array */;
    abstract protected function joinClause(
        /*# : string */ $prefix,
        /*# : string */ $seperator,
        array $clause,
        array $settings
    )/*# : string */;
}