Select::prefixedColumns() - Code Metrics - belgattitude/soluble-db - Measure and Improve Code Quality continuously with Scrutinizer

Select::prefixedColumns() C
last analyzed 2016-01-12 16:30 UTC

↳ Parent: Select

Complexity

Conditions	10
Paths	14

Size

Total Lines	56
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	5
Bugs	3	Features	0

Metric	Value
c	5
b	3
f	0
dl	0
loc	56
rs	6.7742
cc	10
eloc	37
nc	14
nop	1

How to fix Long Method Complexity

<?php

namespace Soluble\Db\Sql;

use Zend\Db\Sql\Sql;
use Zend\Db\Sql\Expression;
use Zend\Db\Sql\Predicate;
use Zend\Db\Sql\Select as ZendDbSqlSelect;
use Zend\Db\Adapter\Adapter;
use Zend\Db\Adapter\AdapterAwareInterface;
use Zend\Db\ResultSet\ResultSet;

class Select extends ZendDbSqlSelect implements AdapterAwareInterface
{
    /**
     *
     * @var Adapter
     */
    protected $adapter;

    /**
     * Constructor
     *
     * @param Adapter $adapter
     * @param  null|string|array|\Zend\Db\Sql\TableIdentifier $table
     */
    public function __construct(Adapter $adapter = null, $table = null)
    {
        if ($adapter) {
            $this->setDbAdapter($adapter);
        }
        parent::__construct($table);
    }


    /**
     * Create an where clause with 'OR'
     *
     * @param  \Zend\Db\Sql\Where|\Closure|string|array|Predicate\PredicateInterface $predicate
     * @throws Zend\Db\Sql\Exception\InvalidArgumentException
     * @return Select
     */
    public function orWhere($predicate)
    {
        return $this->where($predicate, Predicate\PredicateSet::OP_OR);
    }



    /**
     * Add table prefixed columns, will automatically
     * quote table parts identifiers found in the column name.
     * It provides an alternative for defining columns from multiple/joined
     * table in one go.
     *
     * <code>
     * $select->from(array('p' =>'product')
     *        ->prefixedColumns(array('product_title' => 'p.title'));
     * </code>
     * Possible valid states:
     *   array(value, ...)
     *     value can be strings or Expression objects
     *
     *   array(string => value, ...)
     *     key string will be use as alias,
     *     value can be string or Expression objects
     *
     * @throws Exception\InvalidArgumentException when usage not correct
     * @param  array $columns
     * @return Select
     */
    public function prefixedColumns(array $columns)
    {
        $pf = $this->adapter->getPlatform();
        $identifierSeparator = $pf->getIdentifierSeparator();
        $names = array();
        $cols = array();
        foreach ($columns as $alias => $column) {
            if (is_string($column)) {
                if (strpos($column, self::SQL_STAR) !== false) {
                    $msg = __METHOD__ . " Invalid argument, prefixedColumn() does not accept sql * column specification";
                    throw new Exception\InvalidArgumentException($msg);
                }
                $parts = explode($identifierSeparator, $column);
                if (count($parts) > 1) {
                    $quotedParts = array();
                    foreach ($parts as $part) {
                        $quotedParts[] = $pf->quoteIdentifier($part);
                    }
                    // to remove PHPAnalyzer warnings
                    //var_dump($quotedParts[count($quotedParts)-1]);
                    //die();
                    $last_part = $parts[count($parts)-1];

                    if (!is_string($alias)) {
                        $alias = $last_part;
                    }

                    if (in_array($alias, $names)) {
                        $msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
                        throw new Exception\InvalidArgumentException($msg);
                    }
                    $names[] = $alias;

                    $cols[$alias] = new Expression(join($identifierSeparator, $quotedParts));
                } else {
                    if (in_array($alias, $names)) {
                        $msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
                        throw new Exception\InvalidArgumentException($msg);
                    }

                    $cols[$alias] = $column;
                    $names[] = $alias;
                }
            } else {
                if (in_array($alias, $names)) {
                    $msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
                    throw new Exception\InvalidArgumentException($msg);
                }

                $cols[$alias] = $column;
                $names[] = $alias;
            }
        }
        $this->columns($cols);
        return $this;
    }



    /**
     * Set database adapter
     *
     * @param Adapter $adapter
     * @return Select
     */
    public function setDbAdapter(Adapter $adapter)
    {
        $this->adapter = $adapter;
        return $this;
    }

    /**
     * Return an sql string accordingly to the internat database adapter
     *
     * @throws Exception\InvalidUsageException
     * @return string
     */
    public function getSql()
    {
        if ($this->adapter === null) {
            $msg = __METHOD__ . ": Error, prior to use execute method you must provide a valid database adapter. See Select::setDbAdapter() method.";
            throw new Exception\InvalidUsageException($msg);
        }
        $sql = new Sql($this->adapter);
        return $sql->getSqlStringForSqlObject($this);

    }

    /**
     * Execute the query and return a Zend\Db\Resultset\ResultSet object
     *
     * @throws Exception\InvalidUsageException
     * @return \Zend\Db\ResultSet\ResultSet
     */
    public function execute()
    {
        if ($this->adapter === null) {
            $msg = __METHOD__ . ": Error, prior to use execute method you must provide a valid database adapter. See Select::setDbAdapter() method.";
            throw new Exception\InvalidUsageException($msg);
        }
        $sql = new Sql($this->adapter);
        $sql_string = $sql->getSqlStringForSqlObject($this);


        //return $this->adapter->createStatement($sql_string)->execute();
        //return $this->adapter->query($sql_string, Adapter::QUERY_MODE_EXECUTE);
        $result = $this->adapter->getDriver()->getConnection()->execute($sql_string);
        $resultset = new ResultSet();
        $resultset->initialize($result);
        return $resultset;
    }


    /**
     * Return an sql string accordingly to the internat database adapter
     *
     * @throws Exception\InvalidUsageException
     * @return string
     */
    public function __toString()
    {
        return $this->getSql();
    }
}


1			<?php
2
3			namespace Soluble\Db\Sql;
4
5			use Zend\Db\Sql\Sql;
6			use Zend\Db\Sql\Expression;
7			use Zend\Db\Sql\Predicate;
8			use Zend\Db\Sql\Select as ZendDbSqlSelect;
9			use Zend\Db\Adapter\Adapter;
10			use Zend\Db\Adapter\AdapterAwareInterface;
11			use Zend\Db\ResultSet\ResultSet;
12
13			class Select extends ZendDbSqlSelect implements AdapterAwareInterface
14			{
15			/**
16			*
17			* @var Adapter
18			*/
19			protected $adapter;
20
21			/**
22			* Constructor
23			*
24			* @param Adapter $adapter
25			* @param null\|string\|array\|\Zend\Db\Sql\TableIdentifier $table
26			*/
27			public function __construct(Adapter $adapter = null, $table = null)
28			{
29			if ($adapter) {
30			$this->setDbAdapter($adapter);
31			}
32			parent::__construct($table);
33			}
34
35
36			/**
37			* Create an where clause with 'OR'
38			*
39			* @param \Zend\Db\Sql\Where\|\Closure\|string\|array\|Predicate\PredicateInterface $predicate
40			* @throws Zend\Db\Sql\Exception\InvalidArgumentException
41			* @return Select
42			*/
43			public function orWhere($predicate)
44			{
45			return $this->where($predicate, Predicate\PredicateSet::OP_OR);
46			}
47
48
49
50			/**
51			* Add table prefixed columns, will automatically
52			* quote table parts identifiers found in the column name.
53			* It provides an alternative for defining columns from multiple/joined
54			* table in one go.
55			*
56			* <code>
57			* $select->from(array('p' =>'product')
58			* ->prefixedColumns(array('product_title' => 'p.title'));
59			* </code>
60			* Possible valid states:
61			* array(value, ...)
62			* value can be strings or Expression objects
63			*
64			* array(string => value, ...)
65			* key string will be use as alias,
66			* value can be string or Expression objects
67			*
68			* @throws Exception\InvalidArgumentException when usage not correct
69			* @param array $columns
70			* @return Select
71			*/
72			public function prefixedColumns(array $columns)
73			{
74			$pf = $this->adapter->getPlatform();
75			$identifierSeparator = $pf->getIdentifierSeparator();
76			$names = array();
77			$cols = array();
78			foreach ($columns as $alias => $column) {
79			if (is_string($column)) {
80			if (strpos($column, self::SQL_STAR) !== false) {
81			$msg = __METHOD__ . " Invalid argument, prefixedColumn() does not accept sql * column specification";
82			throw new Exception\InvalidArgumentException($msg);
83			}
84			$parts = explode($identifierSeparator, $column);
85			if (count($parts) > 1) {
86			$quotedParts = array();
87			foreach ($parts as $part) {
88			$quotedParts[] = $pf->quoteIdentifier($part);
89			}
90			// to remove PHPAnalyzer warnings
91			//var_dump($quotedParts[count($quotedParts)-1]);
92			//die();
93			$last_part = $parts[count($parts)-1];
94
95			if (!is_string($alias)) {
96			$alias = $last_part;
97			}
98
99			if (in_array($alias, $names)) {
100			$msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
101			throw new Exception\InvalidArgumentException($msg);
102			}
103			$names[] = $alias;
104
105			$cols[$alias] = new Expression(join($identifierSeparator, $quotedParts));
106			} else {
107			if (in_array($alias, $names)) {
108			$msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
109			throw new Exception\InvalidArgumentException($msg);
110			}
111
112			$cols[$alias] = $column;
113			$names[] = $alias;
114			}
115			} else {
116			if (in_array($alias, $names)) {
117			$msg = __METHOD__ . ": Invalid argument, multiple columns have the same alias ($alias)";
118			throw new Exception\InvalidArgumentException($msg);
119			}
120
121			$cols[$alias] = $column;
122			$names[] = $alias;
123			}
124			}
125			$this->columns($cols);
126			return $this;
127			}
128
129
130
131			/**
132			* Set database adapter
133			*
134			* @param Adapter $adapter
135			* @return Select
136			*/
137			public function setDbAdapter(Adapter $adapter)
138			{
139			$this->adapter = $adapter;
140			return $this;
141			}
142
143			/**
144			* Return an sql string accordingly to the internat database adapter
145			*
146			* @throws Exception\InvalidUsageException
147			* @return string
148			*/
149			public function getSql()
150			{
151			if ($this->adapter === null) {
152			$msg = __METHOD__ . ": Error, prior to use execute method you must provide a valid database adapter. See Select::setDbAdapter() method.";
153			throw new Exception\InvalidUsageException($msg);
154			}
155			$sql = new Sql($this->adapter);
156			return $sql->getSqlStringForSqlObject($this);
			0 ignored issues – show Deprecated Code introduced 2016-01-12 16:30 UTC by Report Bug Copy Issue Report The method `Zend\Db\Sql\Sql::getSqlStringForSqlObject()` has been deprecated with message: Deprecated in 2.4. Use buildSqlString() instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
157			}
158
159			/**
160			* Execute the query and return a Zend\Db\Resultset\ResultSet object
161			*
162			* @throws Exception\InvalidUsageException
163			* @return \Zend\Db\ResultSet\ResultSet
164			*/
165			public function execute()
166			{
167			if ($this->adapter === null) {
168			$msg = __METHOD__ . ": Error, prior to use execute method you must provide a valid database adapter. See Select::setDbAdapter() method.";
169			throw new Exception\InvalidUsageException($msg);
170			}
171			$sql = new Sql($this->adapter);
172			$sql_string = $sql->getSqlStringForSqlObject($this);
			0 ignored issues – show Deprecated Code introduced 2016-01-12 16:30 UTC by Report Bug Copy Issue Report The method `Zend\Db\Sql\Sql::getSqlStringForSqlObject()` has been deprecated with message: Deprecated in 2.4. Use buildSqlString() instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
173
174			//return $this->adapter->createStatement($sql_string)->execute();
175			//return $this->adapter->query($sql_string, Adapter::QUERY_MODE_EXECUTE);
176			$result = $this->adapter->getDriver()->getConnection()->execute($sql_string);
177			$resultset = new ResultSet();
178			$resultset->initialize($result);
179			return $resultset;
180			}
181
182
183			/**
184			* Return an sql string accordingly to the internat database adapter
185			*
186			* @throws Exception\InvalidUsageException
187			* @return string
188			*/
189			public function __toString()
190			{
191			return $this->getSql();
192			}
193			}
194

belgattitude / soluble-db

Select::prefixedColumns() C last analyzed 2016-01-12 16:30 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Select::prefixedColumns() C
last analyzed 2016-01-12 16:30 UTC