Source of file State.php
Size: 5,625 Bytes - Last Modified: 2020-04-17T14:56:27-04:00
src/State.php
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277 | <?php declare(strict_types=1); /** * Query * * SQL Query Builder / Database Abstraction Layer * * PHP version 7.4 * * @package Query * @author Timothy J. Warren <tim@timshomepage.net> * @copyright 2012 - 2020 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @link https://git.timshomepage.net/aviat/Query * @version 3.0.0 */ namespace Query; use function is_array; /** * Query builder state * * @method getSelectString(): string * @method getFromString(): string * @method getSetString(): string * @method getOrderString(): string * @method getGroupString(): string * @method getSetArrayKeys(): array * @method getOrderArray(): array * @method getGroupArray(): array * @method getValues(): array * @method getWhereValues(): array * @method getLimit(): int|null * @method getOffset() * @method getQueryMap(): array * @method getHavingMap(): array * * @method setSelectString(string $selectString): self * @method setFromString(string $fromString): self * @method setSetString(string $setString): self * @method setOrderString(string $orderString): self * @method setGroupString(string $groupString): self * @method setSetArrayKeys(array $arrayKeys): self * @method setGroupArray(array $array): self * @method setLimit(int $limit): self * @method setOffset(?int $offset): self */ class State { // -------------------------------------------------------------------------- // ! SQL Clause Strings // -------------------------------------------------------------------------- /** * Compiled 'select' clause * @var string */ protected string $selectString = ''; /** * Compiled 'from' clause * @var string */ protected string $fromString = ''; /** * Compiled arguments for insert / update * @var string */ protected string $setString = ''; /** * Order by clause * @var string */ protected string $orderString = ''; /** * Group by clause * @var string */ protected string $groupString = ''; // -------------------------------------------------------------------------- // ! SQL Clause Arrays // -------------------------------------------------------------------------- /** * Keys for insert/update statement * @var array */ protected array $setArrayKeys = []; /** * Key/val pairs for order by clause * @var array */ protected array $orderArray = []; /** * Key/val pairs for group by clause * @var array */ protected array $groupArray = []; // -------------------------------------------------------------------------- // ! Other Class vars // -------------------------------------------------------------------------- /** * Values to apply to prepared statements * @var array */ protected array $values = []; /** * Values to apply to where clauses in prepared statements * @var array */ protected array $whereValues = []; /** * Value for limit string * @var int */ protected ?int $limit = NULL; /** * Value for offset in limit string * @var int */ protected ?int $offset = NULL; /** * Query component order mapping * for complex select queries * * Format: * [ * 'type' => 'where', * 'conjunction' => ' AND ', * 'string' => 'k=?' * ] * * @var array */ protected array $queryMap = []; /** * Map for having clause * @var array */ protected array $havingMap = []; public function __call(string $name, array $arguments) { if (strpos($name, 'get', 0) === 0) { $maybeProp = lcfirst(substr($name, 3)); if (isset($this->$maybeProp)) { return $this->$maybeProp; } } if (strpos($name, 'set', 0) === 0) { $maybeProp = lcfirst(substr($name, 3)); if (isset($this->$maybeProp)) { $this->$maybeProp = $arguments[0]; return $this; } } return NULL; } /** * @param string $str * @return State */ public function appendSelectString(string $str): self { $this->selectString .= $str; return $this; } /** * @param array $setArrayKeys * @return State */ public function appendSetArrayKeys(array $setArrayKeys): self { $this->setArrayKeys = array_merge($this->setArrayKeys, $setArrayKeys); return $this; } /** * @param string $key * @param mixed $orderArray * @return State */ public function setOrderArray(string $key, $orderArray): self { $this->orderArray[$key] = $orderArray; return $this; } /** * @param string $groupArray * @return State */ public function appendGroupArray(string $groupArray): self { $this->groupArray[] = $groupArray; return $this; } /** * @param array $values * @return State */ public function appendValues(array $values): self { $this->values = array_merge($this->values, $values); return $this; } /** * @param mixed $val * @return State */ public function appendWhereValues($val): self { if (is_array($val)) { foreach($val as $v) { $this->whereValues[] = $v; } return $this; } $this->whereValues[] = $val; return $this; } /** * Add an additional set of mapping pairs to a internal map * * @param string $conjunction * @param string $string * @param string $type * @return State */ public function appendMap(string $conjunction = '', string $string = '', string $type = ''): self { $this->queryMap[] = [ 'type' => $type, 'conjunction' => $conjunction, 'string' => $string ]; return $this; } /** * @param array $item * @return State */ public function appendHavingMap(array $item): self { $this->havingMap[] = $item; return $this; } } |