Select::field() - Code Metrics - Inspection of "Moved the Select-Class to a separat implementation..." - rkrx/php-mysql-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4e8d12...2d631b )

by Ron

created 2021-05-06 16:40 UTC

Select::field() A

↳ Parent: Project

Complexity

Conditions	3
Paths	4

Size

Total Lines	17
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	14
dl	0
loc	17
c	0
b	0
f	0
rs	9.7998
cc	3
nc	4
nop	2

<?php

namespace Kir\MySQL\Builder;

use Kir\MySQL\Builder;
use Kir\MySQL\Builder\Expr\OptionalExpression;
use Kir\MySQL\Builder\Expr\OrderBySpecification;
use Kir\MySQL\Tools\VirtualTable;

/**
 */
interface Select {
	/**
	 * @param bool $preserveTypes
	 * @return $this
	 */
	public function setPreserveTypes(bool $preserveTypes = true);

	/**
	 * @param bool $enabled
	 * @return $this
	 */
	public function forUpdate(bool $enabled = true);

	/**
	 * @param bool $distinct
	 * @return $this
	 */
	public function distinct(bool $distinct = true);

	/**
	 * @return array<int|string, string>
	 */
	public function getFields(): array;

	/**
	 * @param string|Select $expression
	 * @param string|null $alias
	 * @return $this
	 */
	public function field($expression, $alias = null);

	/**
	 * @param array<string, string>|array<int, string> $fields
	 * @return $this
	 */
	public function fields(array $fields);

	/**
	 * @param null|string $alias
	 * @param null|string|Select|VirtualTable|array<int, null|int|float|string|array<string, mixed>> $table
	 * @return $this
	 */
	public function from(?string $alias, $table = null);

	/**
	 * @param string $alias
	 * @param string|array<int, array<string, mixed>>|Select|VirtualTable $table
	 * @param string|null $expression
	 * @param null|int|float|string|array<int, string>|Builder\DBExpr|Select ...$args
	 * @return $this
	 */
	public function joinInner(string $alias, $table, ?string $expression = null, ...$args);

	/**
	 * @param string $alias
	 * @param string|array<int, array<string, mixed>>|Select|VirtualTable $table
	 * @param string $expression
	 * @param string|int|float|array<int, string>|Builder\DBExpr|Select ...$args
	 * @return $this
	 */
	public function joinLeft(string $alias, $table, string $expression, ...$args);

	/**
	 * @param string $alias
	 * @param string|array<int, array<string, mixed>>|Select|VirtualTable $table
	 * @param string $expression
	 * @param string|int|float|array<int, string>|Builder\DBExpr|Select ...$args
	 * @return $this
	 */
	public function joinRight(string $alias, $table, string $expression, ...$args);

	/**
	 * @param string|Select ...$queries
	 * @return $this
	 */
	public function union(...$queries);

	/**
	 * @param string|Select ...$queries
	 * @return $this
	 */
	public function unionAll(...$queries);

	/**
	 * @param string|array<string, mixed>|object|OptionalExpression $expression
	 * @param null|scalar|array<int, string>|DBExpr|Select ...$args
	 * @return $this
	 */
	public function where($expression, ...$args);

	/**
	 * @param string|array<string, mixed>|object|OptionalExpression $expression
	 * @param null|scalar|array<int, string>|DBExpr|Select ...$args
	 * @return $this
	 */
	public function having($expression, ...$args);

	/**
	 * @param mixed ...$args
	 * @return $this
	 */
	public function groupBy(...$args);

	/**
	 * @param string|OrderBySpecification $expression
	 * @param string&('ASC'|'DESC') $direction

	 * @return $this
	 */
	public function orderBy($expression, string $direction = 'ASC');

	/**
	 * @param string $fieldName
	 * @param array<int, int|float|string> $values
	 * @return $this
	 */
	public function orderByValues(string $fieldName, array $values);

	/**
	 * @param int|null $limit
	 * @return $this
	 */
	public function limit(?int $limit);

	/**
	 * @param int|null $offset
	 * @return $this
	 */
	public function offset(?int $offset = 0);

	/**
	 * @return bool
	 */
	public function getCalcFoundRows(): bool;

	/**
	 * @param bool $calcFoundRows
	 * @return $this
	 */
	public function setCalcFoundRows($calcFoundRows = true);

	/**
	 * @return string
	 */
	public function __toString(): string;
}


1			<?php
2
3			namespace Kir\MySQL\Builder;
4
5			use Kir\MySQL\Builder;
6			use Kir\MySQL\Builder\Expr\OptionalExpression;
7			use Kir\MySQL\Builder\Expr\OrderBySpecification;
8			use Kir\MySQL\Tools\VirtualTable;
9
10			/**
11			*/
12			interface Select {
13			/**
14			* @param bool $preserveTypes
15			* @return $this
16			*/
17			public function setPreserveTypes(bool $preserveTypes = true);
18
19			/**
20			* @param bool $enabled
21			* @return $this
22			*/
23			public function forUpdate(bool $enabled = true);
24
25			/**
26			* @param bool $distinct
27			* @return $this
28			*/
29			public function distinct(bool $distinct = true);
30
31			/**
32			* @return array<int\|string, string>
33			*/
34			public function getFields(): array;
35
36			/**
37			* @param string\|Select $expression
38			* @param string\|null $alias
39			* @return $this
40			*/
41			public function field($expression, $alias = null);
42
43			/**
44			* @param array<string, string>\|array<int, string> $fields
45			* @return $this
46			*/
47			public function fields(array $fields);
48
49			/**
50			* @param null\|string $alias
51			* @param null\|string\|Select\|VirtualTable\|array<int, null\|int\|float\|string\|array<string, mixed>> $table
52			* @return $this
53			*/
54			public function from(?string $alias, $table = null);
55
56			/**
57			* @param string $alias
58			* @param string\|array<int, array<string, mixed>>\|Select\|VirtualTable $table
59			* @param string\|null $expression
60			* @param null\|int\|float\|string\|array<int, string>\|Builder\DBExpr\|Select ...$args
61			* @return $this
62			*/
63			public function joinInner(string $alias, $table, ?string $expression = null, ...$args);
64
65			/**
66			* @param string $alias
67			* @param string\|array<int, array<string, mixed>>\|Select\|VirtualTable $table
68			* @param string $expression
69			* @param string\|int\|float\|array<int, string>\|Builder\DBExpr\|Select ...$args
70			* @return $this
71			*/
72			public function joinLeft(string $alias, $table, string $expression, ...$args);
73
74			/**
75			* @param string $alias
76			* @param string\|array<int, array<string, mixed>>\|Select\|VirtualTable $table
77			* @param string $expression
78			* @param string\|int\|float\|array<int, string>\|Builder\DBExpr\|Select ...$args
79			* @return $this
80			*/
81			public function joinRight(string $alias, $table, string $expression, ...$args);
82
83			/**
84			* @param string\|Select ...$queries
85			* @return $this
86			*/
87			public function union(...$queries);
88
89			/**
90			* @param string\|Select ...$queries
91			* @return $this
92			*/
93			public function unionAll(...$queries);
94
95			/**
96			* @param string\|array<string, mixed>\|object\|OptionalExpression $expression
97			* @param null\|scalar\|array<int, string>\|DBExpr\|Select ...$args
98			* @return $this
99			*/
100			public function where($expression, ...$args);
101
102			/**
103			* @param string\|array<string, mixed>\|object\|OptionalExpression $expression
104			* @param null\|scalar\|array<int, string>\|DBExpr\|Select ...$args
105			* @return $this
106			*/
107			public function having($expression, ...$args);
108
109			/**
110			* @param mixed ...$args
111			* @return $this
112			*/
113			public function groupBy(...$args);
114
115			/**
116			* @param string\|OrderBySpecification $expression
117			* @param string&('ASC'\|'DESC') $direction
			0 ignored issues – show Documentation Bug introduced 2021-05-06 16:42 UTC by Report Bug Copy Issue Report The doc comment `string&('ASC'\|'DESC')` at position `3` could not be parsed: Unknown type name ''ASC'' at position 3 in string&('ASC'\|'DESC'). Loading history...
118			* @return $this
119			*/
120			public function orderBy($expression, string $direction = 'ASC');
121
122			/**
123			* @param string $fieldName
124			* @param array<int, int\|float\|string> $values
125			* @return $this
126			*/
127			public function orderByValues(string $fieldName, array $values);
128
129			/**
130			* @param int\|null $limit
131			* @return $this
132			*/
133			public function limit(?int $limit);
134
135			/**
136			* @param int\|null $offset
137			* @return $this
138			*/
139			public function offset(?int $offset = 0);
140
141			/**
142			* @return bool
143			*/
144			public function getCalcFoundRows(): bool;
145
146			/**
147			* @param bool $calcFoundRows
148			* @return $this
149			*/
150			public function setCalcFoundRows($calcFoundRows = true);
151
152			/**
153			* @return string
154			*/
155			public function __toString(): string;
156			}
157

rkrx / php-mysql-query-builder

Push — master ( 4e8d12...2d631b )

Select::field() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like