AuraBuilder::select() - Code Metrics - Inspection of "WIP" - asyncphp/icicle-database - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 59df9b...8cdd26 )

by Christopher

created 2015-12-02 06:41 UTC

AuraBuilder::select() A

↳ Parent: AuraBuilder

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	9

Duplication

Lines	16
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	16
loc	16
ccs	0
cts	13
cp	0
rs	9.4286
cc	3
eloc	9
nc	3
nop	1
crap	12

<?php

namespace AsyncPHP\Icicle\Database\Builder;

use AsyncPHP\Icicle\Database\Builder;
use Aura\SqlQuery\QueryFactory;
use Aura\SqlQuery\QueryInterface;
use LogicException;

class AuraBuilder implements Builder
{
    /**
     * @var QueryFactory
     */
    protected $factory;

    /**
     * @var QueryInterface
     */
    protected $query;

    /**
     * @var string
     */
    protected $table;

    /**
     * @param QueryFactory $factory
     */
    public function __construct(QueryFactory $factory)
    {
        $this->factory = $factory;
    }

    /**
     * @param string $key
     * @param mixed $value
     *
     * @return static
     */
    public function cloneWith($key, $value)
    {
        $clone = clone $this;
        $clone->$key = $value;

        return $clone;
    }

    /**
     * @return array
     *
     * @throws LogicException
     */
    public function build()
    {
        if (!isset($this->query)) {
            throw new LogicException("build() called before select(), insert(), update() or delete()");
        }

        return [
            $this->query->getStatement(),
            $this->query->getBindValues(),
        ];
    }

    /**
     * @return static
     *
     * @throws LogicException
     */
    public function delete()

    {
        if (!isset($this->table)) {
            throw new LogicException("delete() called before table()");
        }

        $query = $this->factory->newDelete();
        $query->from($this->table);

        return $this->cloneWith("query", $query);
    }

    /**
     * @param array $data
     *
     * @return static
     *
     * @throws LogicException
     */
    public function insert(array $data)

    {
        if (!isset($this->table)) {
            throw new LogicException("insert() called before table()");
        }

        $query = $this->factory->newInsert();
        $query->into($this->table);
        $query->cols($data);

        return $this->cloneWith("query", $query);
    }

    /**
     * @param int $limit
     * @param int $offset
     *
     * @return static
     *
     * @throws LogicException
     */
    public function limit($limit, $offset = 0)
    {
        if (!isset($this->query)) {
            throw new LogicException("limit() called before select()");
        }

        $query = clone $this->query;
        $query->limit($limit);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        $query->offset($offset);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this->cloneWith("query", $query);
    }

    /**
     * @param string $order
     *
     * @return static
     *
     * @throws LogicException
     */
    public function orderBy($order)

    {
        if (!isset($this->query)) {
            throw new LogicException("orderBy() called before select()");
        }

        if (!is_array($order)) {
            $order = [$order];
        }

        $query = clone $this->query;
        $query->orderBy($order);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        return $this->cloneWith("query", $query);
    }

    /**
     * @param mixed $where
     *
     * @return static
     *
     * @throws LogicException
     */
    public function orWhere($where)
    {
        if (!isset($this->query)) {
            throw new LogicException("orWhere() called before select(), update() or delete()");
        }

        $query = clone $this->query;
        call_user_func_array([$query, "orWhere"], func_get_args());

        return $this->cloneWith("query", $query);
    }

    /**
     * @param string $columns
     *
     * @return static
     *
     * @throws LogicException
     */
    public function select($columns = "*")

    {
        if (!isset($this->table)) {
            throw new LogicException("select() called before table()");
        }

        if (!is_array($columns)) {
            $columns = [$columns];
        }

        $query = $this->factory->newSelect();
        $query->from($this->table);
        $query->cols($columns);

        return $this->cloneWith("query", $query);
    }

    /**
     * @param string $table
     *
     * @return static
     */
    public function table($table)
    {
        return $this->cloneWith("table", $table);
    }

    /**
     * @param array $data
     *
     * @return static
     *
     * @throws LogicException
     */
    public function update(array $data)

    {
        if (!isset($this->table)) {
            throw new LogicException("update() called before table()");
        }

        $query = $this->factory->newUpdate();
        $query->table($this->table);
        $query->cols($data);

        return $this->cloneWith("query", $query);
    }

    /**
     * @param mixed $where
     *
     * @return static
     *
     * @throws LogicException
     */
    public function where($where)
    {
        if (!isset($this->query)) {
            throw new LogicException("where() called before select(), update() or delete()");
        }

        $query = clone $this->query;
        call_user_func_array([$query, "where"], func_get_args());

        return $this->cloneWith("query", $query);
    }
}


Push — master ( 59df9b...8cdd26 )

AuraBuilder::select() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace AsyncPHP\Icicle\Database\Builder;
4
5		use AsyncPHP\Icicle\Database\Builder;
6		use Aura\SqlQuery\QueryFactory;
7		use Aura\SqlQuery\QueryInterface;
8		use LogicException;
9
10		class AuraBuilder implements Builder
11		{
12		/**
13		* @var QueryFactory
14		*/
15		protected $factory;
16
17		/**
18		* @var QueryInterface
19		*/
20		protected $query;
21
22		/**
23		* @var string
24		*/
25		protected $table;
26
27		/**
28		* @param QueryFactory $factory
29		*/
30		public function __construct(QueryFactory $factory)
31		{
32		$this->factory = $factory;
33		}
34
35		/**
36		* @param string $key
37		* @param mixed $value
38		*
39		* @return static
40		*/
41		public function cloneWith($key, $value)
42		{
43		$clone = clone $this;
44		$clone->$key = $value;
45
46		return $clone;
47		}
48
49		/**
50		* @return array
51		*
52		* @throws LogicException
53		*/
54		public function build()
55		{
56		if (!isset($this->query)) {
57		throw new LogicException("build() called before select(), insert(), update() or delete()");
58		}
59
60		return [
61		$this->query->getStatement(),
62		$this->query->getBindValues(),
63		];
64		}
65
66		/**
67		* @return static
68		*
69		* @throws LogicException
70		*/
71	View Code Duplication	public function delete()
		0 ignored issues – show Duplication introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		{
73		if (!isset($this->table)) {
74		throw new LogicException("delete() called before table()");
75		}
76
77		$query = $this->factory->newDelete();
78		$query->from($this->table);
79
80		return $this->cloneWith("query", $query);
81		}
82
83		/**
84		* @param array $data
85		*
86		* @return static
87		*
88		* @throws LogicException
89		*/
90	View Code Duplication	public function insert(array $data)
		0 ignored issues – show Duplication introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
91		{
92		if (!isset($this->table)) {
93		throw new LogicException("insert() called before table()");
94		}
95
96		$query = $this->factory->newInsert();
97		$query->into($this->table);
98		$query->cols($data);
99
100		return $this->cloneWith("query", $query);
101		}
102
103		/**
104		* @param int $limit
105		* @param int $offset
106		*
107		* @return static
108		*
109		* @throws LogicException
110		*/
111		public function limit($limit, $offset = 0)
112		{
113		if (!isset($this->query)) {
114		throw new LogicException("limit() called before select()");
115		}
116
117		$query = clone $this->query;
118		$query->limit($limit);
		0 ignored issues – show Bug introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aura\SqlQuery\QueryInterface` as the method `limit()` does only exist in the following implementations of said interface: `Aura\SqlQuery\Common\Select`, `Aura\SqlQuery\Mysql\Delete`, `Aura\SqlQuery\Mysql\Select`, `Aura\SqlQuery\Mysql\Update`, `Aura\SqlQuery\Pgsql\Select`, `Aura\SqlQuery\Sqlite\Delete`, `Aura\SqlQuery\Sqlite\Select`, `Aura\SqlQuery\Sqlite\Update`, `Aura\SqlQuery\Sqlsrv\Select`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
119		$query->offset($offset);
		0 ignored issues – show Bug introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aura\SqlQuery\QueryInterface` as the method `offset()` does only exist in the following implementations of said interface: `Aura\SqlQuery\Common\Select`, `Aura\SqlQuery\Mysql\Select`, `Aura\SqlQuery\Pgsql\Select`, `Aura\SqlQuery\Sqlite\Delete`, `Aura\SqlQuery\Sqlite\Select`, `Aura\SqlQuery\Sqlite\Update`, `Aura\SqlQuery\Sqlsrv\Select`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
120
121		return $this->cloneWith("query", $query);
122		}
123
124		/**
125		* @param string $order
126		*
127		* @return static
128		*
129		* @throws LogicException
130		*/
131	View Code Duplication	public function orderBy($order)
		0 ignored issues – show Duplication introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
132		{
133		if (!isset($this->query)) {
134		throw new LogicException("orderBy() called before select()");
135		}
136
137		if (!is_array($order)) {
138		$order = [$order];
139		}
140
141		$query = clone $this->query;
142		$query->orderBy($order);
		0 ignored issues – show Bug introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aura\SqlQuery\QueryInterface` as the method `orderBy()` does only exist in the following implementations of said interface: `Aura\SqlQuery\Common\Select`, `Aura\SqlQuery\Mysql\Delete`, `Aura\SqlQuery\Mysql\Select`, `Aura\SqlQuery\Mysql\Update`, `Aura\SqlQuery\Pgsql\Select`, `Aura\SqlQuery\Sqlite\Delete`, `Aura\SqlQuery\Sqlite\Select`, `Aura\SqlQuery\Sqlite\Update`, `Aura\SqlQuery\Sqlsrv\Select`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
143
144		return $this->cloneWith("query", $query);
145		}
146
147		/**
148		* @param mixed $where
149		*
150		* @return static
151		*
152		* @throws LogicException
153		*/
154		public function orWhere($where)
155		{
156		if (!isset($this->query)) {
157		throw new LogicException("orWhere() called before select(), update() or delete()");
158		}
159
160		$query = clone $this->query;
161		call_user_func_array([$query, "orWhere"], func_get_args());
162
163		return $this->cloneWith("query", $query);
164		}
165
166		/**
167		* @param string $columns
168		*
169		* @return static
170		*
171		* @throws LogicException
172		*/
173	View Code Duplication	public function select($columns = "*")
		0 ignored issues – show Duplication introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
174		{
175		if (!isset($this->table)) {
176		throw new LogicException("select() called before table()");
177		}
178
179		if (!is_array($columns)) {
180		$columns = [$columns];
181		}
182
183		$query = $this->factory->newSelect();
184		$query->from($this->table);
185		$query->cols($columns);
186
187		return $this->cloneWith("query", $query);
188		}
189
190		/**
191		* @param string $table
192		*
193		* @return static
194		*/
195		public function table($table)
196		{
197		return $this->cloneWith("table", $table);
198		}
199
200		/**
201		* @param array $data
202		*
203		* @return static
204		*
205		* @throws LogicException
206		*/
207	View Code Duplication	public function update(array $data)
		0 ignored issues – show Duplication introduced 2015-12-02 06:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
208		{
209		if (!isset($this->table)) {
210		throw new LogicException("update() called before table()");
211		}
212
213		$query = $this->factory->newUpdate();
214		$query->table($this->table);
215		$query->cols($data);
216
217		return $this->cloneWith("query", $query);
218		}
219
220		/**
221		* @param mixed $where
222		*
223		* @return static
224		*
225		* @throws LogicException
226		*/
227		public function where($where)
228		{
229		if (!isset($this->query)) {
230		throw new LogicException("where() called before select(), update() or delete()");
231		}
232
233		$query = clone $this->query;
234		call_user_func_array([$query, "where"], func_get_args());
235
236		return $this->cloneWith("query", $query);
237		}
238		}
239

asyncphp / icicle-database

Push — master ( 59df9b...8cdd26 )

AuraBuilder::select() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like