Update::setExpr() - Code Metrics - rkrx/php-mysql-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Update::setExpr() A
last analyzed 2025-06-27 08:19 UTC

↳ Parent: Update

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
dl	0
loc	7
c	0
b	0
f	0
rs	10
cc	2
nc	2
nop	2

<?php
namespace Kir\MySQL\Builder;

use Kir\MySQL\Builder\Internal\DefaultValue;
use Kir\MySQL\Builder\Internal\Types;
use Kir\MySQL\Builder\Traits\JoinBuilder;
use Kir\MySQL\Builder\Traits\LimitBuilder;
use Kir\MySQL\Builder\Traits\OffsetBuilder;
use Kir\MySQL\Builder\Traits\OrderByBuilder;
use Kir\MySQL\Builder\Traits\TableBuilder;
use Kir\MySQL\Builder\Traits\TableNameBuilder;
use Kir\MySQL\Builder\Traits\WhereBuilder;
use RuntimeException;

/**
 * @phpstan-import-type DBTableNameType from Types
 */
abstract class Update extends InsertUpdateStatement {
	use TableNameBuilder;
	use TableBuilder;
	use JoinBuilder;
	use WhereBuilder;
	use OrderByBuilder;
	use LimitBuilder;
	use OffsetBuilder;

	/** @var mixed[] */
	private array $fields = [];

	/**
	 * @param ($table is null ? DBTableNameType : string) $alias
filter:
    dependency_paths: ["lib/*"]
	 * @param null|DBTableNameType $table
filter:
    dependency_paths: ["lib/*"]
	 * @return $this
	 */
	public function table($alias, $table = null): self {
		if($table === null) {
			[$alias, $table] = [$table, $alias];
		}
		$this->addTable($alias, $table);
		return $this;
	}

	/**
	 * @param string $fieldName
	 * @param mixed $value
	 * @return $this
	 */
	public function set(string $fieldName, $value): self {
		$sqlField = $fieldName;
		$sqlValue = $this->db()->quote($value);
		$this->fields[$sqlField] = $sqlValue;
		return $this;
	}

	/**
	 * @param string $fieldName
	 * @return $this
	 */
	public function setDefault(string $fieldName): self {
		$sqlField = $fieldName;
		$this->fields[$sqlField] = new DefaultValue();
		return $this;
	}

	/**
	 * @param string $expr
	 * @param mixed ...$args
	 * @return $this
	 */
	public function setExpr(string $expr, ...$args): self {
		if(count($args) > 0) {
			$this->fields[] = func_get_args();
		} else {
			$this->fields[] = $expr;
		}
		return $this;
	}

	/**
	 * @param array<string, mixed> $data
	 * @param array<int, string>|null $allowedFields
	 * @return $this
	 */
	public function setAll(array $data, ?array $allowedFields = null): self {
		if($allowedFields !== null) {
			foreach($data as $fieldName => $value) {
				if(in_array($fieldName, $allowedFields)) {
					$this->set($fieldName, $value);
				}
			}
		} else {
			$values = $this->clearValues($data);
			foreach($values as $fieldName => $value) {
				$this->set($fieldName, $value);
			}
		}
		return $this;
	}

	/**
	 * @param array<string, mixed> $params
	 * @return int
	 */
	abstract public function run(array $params = []): int;

	/**
	 * @return string
	 */
	public function __toString(): string {
		$query = "UPDATE\n";
		$query = $this->buildTables($query);
		$query = $this->buildJoins($query);
		$query .= "SET\n";
		$query = $this->buildAssignments($query);
		$query = $this->buildWhereConditions($query);
		$query = $this->buildOrder($query);
		$query = $this->buildLimit($query);
		$query = $this->buildOffset($query);
		return $query;
	}

	/**
	 * @param string $query
	 * @return string
	 */
	private function buildAssignments(string $query): string {
		$sqlFields = $this->buildFieldList($this->fields);
		if(!count($sqlFields)) {
			throw new RuntimeException('No field-data found');
		}
		return sprintf("%s%s\n", $query, implode(",\n", $sqlFields));
	}

	/**
	 * @param array<string, mixed> $values
	 * @return array<string, mixed>
	 */
	private function clearValues(array $values): array {
		if(!count($values)) {
			return [];
		}
		$tables = $this->getTables();
		if(!count($tables)) {
			throw new RuntimeException('Table name is missing');
		}
		if(count($tables) > 1) {
			throw new RuntimeException('Batch values only work with max. one table');
		}

		$table = $tables[0];
		$tableName = $table['name'];

		$result = [];
		if(is_string($tableName)) {

			$fields = $this->db()->getTableFields($tableName);

			foreach($values as $fieldName => $fieldValue) {
				if(in_array($fieldName, $fields, true)) {
					$result[$fieldName] = $fieldValue;
				}
			}
		}
		return $result;
	}
}


1			<?php
2			namespace Kir\MySQL\Builder;
3
4			use Kir\MySQL\Builder\Internal\DefaultValue;
5			use Kir\MySQL\Builder\Internal\Types;
6			use Kir\MySQL\Builder\Traits\JoinBuilder;
7			use Kir\MySQL\Builder\Traits\LimitBuilder;
8			use Kir\MySQL\Builder\Traits\OffsetBuilder;
9			use Kir\MySQL\Builder\Traits\OrderByBuilder;
10			use Kir\MySQL\Builder\Traits\TableBuilder;
11			use Kir\MySQL\Builder\Traits\TableNameBuilder;
12			use Kir\MySQL\Builder\Traits\WhereBuilder;
13			use RuntimeException;
14
15			/**
16			* @phpstan-import-type DBTableNameType from Types
17			*/
18			abstract class Update extends InsertUpdateStatement {
19			use TableNameBuilder;
20			use TableBuilder;
21			use JoinBuilder;
22			use WhereBuilder;
23			use OrderByBuilder;
24			use LimitBuilder;
25			use OffsetBuilder;
26
27			/** @var mixed[] */
28			private array $fields = [];
29
30			/**
31			* @param ($table is null ? DBTableNameType : string) $alias
			0 ignored issues – show Bug introduced 2025-05-25 17:17 UTC by Report Bug Copy Issue Report The type `Kir\MySQL\Builder\is` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
32			* @param null\|DBTableNameType $table
			0 ignored issues – show Bug introduced 2025-05-25 17:17 UTC by Report Bug Copy Issue Report The type `Kir\MySQL\Builder\DBTableNameType` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
33			* @return $this
34			*/
35			public function table($alias, $table = null): self {
36			if($table === null) {
37			[$alias, $table] = [$table, $alias];
38			}
39			$this->addTable($alias, $table);
40			return $this;
41			}
42
43			/**
44			* @param string $fieldName
45			* @param mixed $value
46			* @return $this
47			*/
48			public function set(string $fieldName, $value): self {
49			$sqlField = $fieldName;
50			$sqlValue = $this->db()->quote($value);
51			$this->fields[$sqlField] = $sqlValue;
52			return $this;
53			}
54
55			/**
56			* @param string $fieldName
57			* @return $this
58			*/
59			public function setDefault(string $fieldName): self {
60			$sqlField = $fieldName;
61			$this->fields[$sqlField] = new DefaultValue();
62			return $this;
63			}
64
65			/**
66			* @param string $expr
67			* @param mixed ...$args
68			* @return $this
69			*/
70			public function setExpr(string $expr, ...$args): self {
71			if(count($args) > 0) {
72			$this->fields[] = func_get_args();
73			} else {
74			$this->fields[] = $expr;
75			}
76			return $this;
77			}
78
79			/**
80			* @param array<string, mixed> $data
81			* @param array<int, string>\|null $allowedFields
82			* @return $this
83			*/
84			public function setAll(array $data, ?array $allowedFields = null): self {
85			if($allowedFields !== null) {
86			foreach($data as $fieldName => $value) {
87			if(in_array($fieldName, $allowedFields)) {
88			$this->set($fieldName, $value);
89			}
90			}
91			} else {
92			$values = $this->clearValues($data);
93			foreach($values as $fieldName => $value) {
94			$this->set($fieldName, $value);
95			}
96			}
97			return $this;
98			}
99
100			/**
101			* @param array<string, mixed> $params
102			* @return int
103			*/
104			abstract public function run(array $params = []): int;
105
106			/**
107			* @return string
108			*/
109			public function __toString(): string {
110			$query = "UPDATE\n";
111			$query = $this->buildTables($query);
112			$query = $this->buildJoins($query);
113			$query .= "SET\n";
114			$query = $this->buildAssignments($query);
115			$query = $this->buildWhereConditions($query);
116			$query = $this->buildOrder($query);
117			$query = $this->buildLimit($query);
118			$query = $this->buildOffset($query);
119			return $query;
120			}
121
122			/**
123			* @param string $query
124			* @return string
125			*/
126			private function buildAssignments(string $query): string {
127			$sqlFields = $this->buildFieldList($this->fields);
128			if(!count($sqlFields)) {
129			throw new RuntimeException('No field-data found');
130			}
131			return sprintf("%s%s\n", $query, implode(",\n", $sqlFields));
132			}
133
134			/**
135			* @param array<string, mixed> $values
136			* @return array<string, mixed>
137			*/
138			private function clearValues(array $values): array {
139			if(!count($values)) {
140			return [];
141			}
142			$tables = $this->getTables();
143			if(!count($tables)) {
144			throw new RuntimeException('Table name is missing');
145			}
146			if(count($tables) > 1) {
147			throw new RuntimeException('Batch values only work with max. one table');
148			}
149
150			$table = $tables[0];
151			$tableName = $table['name'];
152
153			$result = [];
154			if(is_string($tableName)) {
			0 ignored issues – show introduced 2025-05-25 17:17 UTC by Report Bug Copy Issue Report The condition `is_string($tableName)` is always `false`. Loading history...
155			$fields = $this->db()->getTableFields($tableName);
156
157			foreach($values as $fieldName => $fieldValue) {
158			if(in_array($fieldName, $fields, true)) {
159			$result[$fieldName] = $fieldValue;
160			}
161			}
162			}
163			return $result;
164			}
165			}
166

rkrx / php-mysql-query-builder

Update::setExpr() A last analyzed 2025-06-27 08:19 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Update::setExpr() A
last analyzed 2025-06-27 08:19 UTC