Source of file AbstractDriver.php
- Size: 15,613 Bytes - Last Modified: 2020-04-17T14:56:27-04:00
src/Drivers/AbstractDriver.php
| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717 | <?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\Drivers; use function dbFilter; use InvalidArgumentException; use PDO; use PDOStatement; use function is_string; /** * Base Database class * * Extends PDO to simplify cross-database issues */abstract class AbstractDriver extends PDO implements DriverInterface { /** * Reference to the last executed query * @var PDOStatement */protected PDOStatement $statement; /** * Start character to escape identifiers * @var string */protected string $escapeCharOpen = '"'; /** * End character to escape identifiers * @var string */protected string $escapeCharClose = '"'; /** * Reference to sql class * @var SQLInterface */protected SQLInterface $driverSQL; /** * Reference to util class * @var AbstractUtil */protected AbstractUtil $util; /** * Last query executed * @var string */protected string $lastQuery = ''; /** * Prefix to apply to table names * @var string */protected string $tablePrefix = ''; /** * Whether the driver supports 'TRUNCATE' * @var boolean */protected bool $hasTruncate = TRUE; /** * PDO constructor wrapper * * @param string $dsn * @param string $username * @param string $password * @param array $driverOptions */public function __construct(string $dsn, string $username=NULL, string $password=NULL, array $driverOptions=[]) { // Set PDO to display errors as exceptions, and apply driver options $driverOptions[PDO::ATTR_ERRMODE] = PDO::ERRMODE_EXCEPTION; parent::__construct($dsn, $username, $password, $driverOptions); $this->_loadSubClasses(); } /** * Loads the subclasses for the driver * * @return void */protected function _loadSubClasses(): void { // Load the sql and util class for the driver $thisClass = \get_class($this); $nsArray = explode("\\", $thisClass); array_pop($nsArray); $driver = array_pop($nsArray); $sqlClass = __NAMESPACE__ . "\\{$driver}\\SQL"; $utilClass = __NAMESPACE__ . "\\{$driver}\\Util"; $this->driverSQL = new $sqlClass(); $this->util = new $utilClass($this); } /** * Allow invoke to work on table object * * @codeCoverageIgnore * @param string $name * @param array $args * @return mixed */public function __call(string $name, array $args = []) { if ( isset($this->$name) && \is_object($this->$name) && method_exists($this->$name, '__invoke') ) { return \call_user_func_array([$this->$name, '__invoke'], $args); } return NULL; } // -------------------------------------------------------------------------- // ! Accessors / Mutators // -------------------------------------------------------------------------- /** * Get the last sql query executed * * @return string */public function getLastQuery(): string { return $this->lastQuery; } /** * Set the last query sql * * @param string $queryString * @return void */public function setLastQuery(string $queryString): void { $this->lastQuery = $queryString; } /** * Get the SQL class for the current driver * * @return SQLInterface */public function getSql(): SQLInterface { return $this->driverSQL; } /** * Get the Util class for the current driver * * @return AbstractUtil */public function getUtil(): AbstractUtil { return $this->util; } /** * Set the common table name prefix * * @param string $prefix * @return void */public function setTablePrefix(string $prefix): void { $this->tablePrefix = $prefix; } // -------------------------------------------------------------------------- // ! Concrete functions that can be overridden in child classes // -------------------------------------------------------------------------- /** * Simplifies prepared statements for database queries * * @param string $sql * @param array $data * @return PDOStatement | FALSE * @throws InvalidArgumentException */public function prepareQuery(string $sql, array $data): PDOStatement { // Prepare the sql, save the statement for easy access later $this->statement = $this->prepare($sql); // Bind the parameters foreach($data as $k => $value) { // Parameters are 1-based, the data is 0-based // So, if the key is numeric, add 1 if(is_numeric($k)) { $k++; } $this->statement->bindValue($k, $value); } return $this->statement; } /** * Create and execute a prepared statement with the provided parameters * * @param string $sql * @param array $params * @throws InvalidArgumentException * @return PDOStatement */public function prepareExecute(string $sql, array $params): PDOStatement { $this->statement = $this->prepareQuery($sql, $params); $this->statement->execute(); return $this->statement; } /** * Returns number of rows affected by an INSERT, UPDATE, DELETE type query * * @return int */public function affectedRows(): int { // Return number of rows affected return $this->statement->rowCount(); } /** * Prefixes a table if it is not already prefixed * @param string $table * @return string */public function prefixTable(string $table): string { // Add the prefix to the table name // before quoting it if ( ! empty($this->tablePrefix)) { // Split identifier by period, will split into: // database.schema.table OR // schema.table OR // database.table OR // table $identifiers = explode('.', $table); $segments = count($identifiers); // Quote the last item, and add the database prefix $identifiers[$segments - 1] = $this->_prefix(end($identifiers)); // Rejoin $table = implode('.', $identifiers); } return $table; } /** * Quote database table name, and set prefix * * @param string $table * @return string */public function quoteTable($table): string { $table = $this->prefixTable($table); // Finally, quote the table return $this->quoteIdent($table); } /** * Surrounds the string with the databases identifier escape characters * * @param mixed $identifier * @return string|array */public function quoteIdent($identifier) { if (is_array($identifier)) { return array_map([$this, __METHOD__], $identifier); } // Handle comma-separated identifiers if (strpos($identifier, ',') !== FALSE) { $parts = array_map('mb_trim', explode(',', $identifier)); $parts = array_map([$this, __METHOD__], $parts); $identifier = implode(',', $parts); } // Split each identifier by the period $hiers = explode('.', $identifier); $hiers = array_map('mb_trim', $hiers); // Re-compile the string $raw = implode('.', array_map([$this, '_quote'], $hiers)); // Fix functions $funcs = []; preg_match_all("#{$this->escapeCharOpen}([a-zA-Z0-9_]+(\((.*?)\))){$this->escapeCharClose}#iu", $raw, $funcs, PREG_SET_ORDER); foreach($funcs as $f) { // Unquote the function // Quote the inside identifiers $raw = str_replace(array($f[0], $f[3]), array($f[1], $this->quoteIdent($f[3])), $raw); } return $raw; } /** * Return schemas for databases that list them * * @return array */public function getSchemas(): ?array { // Most DBMSs conflate schemas and databases return $this->getDbs(); } /** * Return list of tables for the current database * * @return array */public function getTables(): ?array { $tables = $this->driverQuery('tableList'); natsort($tables); return $tables; } /** * Return list of dbs for the current connection, if possible * * @return array */public function getDbs(): ?array { return $this->driverQuery('dbList'); } /** * Return list of views for the current database * * @return array */public function getViews(): ?array { $views = $this->driverQuery('viewList'); sort($views); return $views; } /** * Return list of sequences for the current database, if they exist * * @return array */public function getSequences(): ?array { return $this->driverQuery('sequenceList'); } /** * Return list of functions for the current database * * @return array */public function getFunctions(): ?array { return $this->driverQuery('functionList', FALSE); } /** * Return list of stored procedures for the current database * * @return array */public function getProcedures(): ?array { return $this->driverQuery('procedureList', FALSE); } /** * Return list of triggers for the current database * * @return array */public function getTriggers(): ?array { return $this->driverQuery('triggerList', FALSE); } /** * Retrieves an array of non-user-created tables for * the connection/database * * @return array */public function getSystemTables(): ?array { return $this->driverQuery('systemTableList'); } /** * Retrieve column information for the current database table * * @param string $table * @return array */public function getColumns(string $table): ?array { return $this->driverQuery($this->getSql()->columnList($this->prefixTable($table)), FALSE); } /** * Retrieve foreign keys for the table * * @param string $table * @return array */public function getFks(string $table): ?array { return $this->driverQuery($this->getSql()->fkList($table), FALSE); } /** * Retrieve indexes for the table * * @param string $table * @return array */public function getIndexes(string $table): ?array { return $this->driverQuery($this->getSql()->indexList($this->prefixTable($table)), FALSE); } /** * Retrieve list of data types for the database * * @return array */public function getTypes(): ?array { return $this->driverQuery('typeList', FALSE); } /** * Get the version of the database engine * * @return string */public function getVersion(): string { return $this->getAttribute(PDO::ATTR_SERVER_VERSION); } /** * Method to simplify retrieving db results for meta-data queries * * @param string|array|null $query * @param bool $filteredIndex * @return array|null */public function driverQuery($query, $filteredIndex=TRUE): ?array { // Call the appropriate method, if it exists if (is_string($query) && method_exists($this->driverSQL, $query)) { $query = $this->getSql()->$query(); } // Return if the values are returned instead of a query, // or if the query doesn't apply to the driver if ( ! is_string($query)) { return $query; } // Run the query! $res = $this->query($query); $flag = $filteredIndex ? PDO::FETCH_NUM : PDO::FETCH_ASSOC; $all = $res->fetchAll($flag); return $filteredIndex ? dbFilter($all, 0) : $all; } /** * Return the number of rows returned for a SELECT query * * @see http://us3.php.net/manual/en/pdostatement.rowcount.php#87110 * @return int|null */public function numRows(): ?int { $regex = '/^SELECT\s+(?:ALL\s+|DISTINCT\s+)?(?:.*?)\s+FROM\s+(.*)$/i'; $output = []; if (preg_match($regex, $this->lastQuery, $output) > 0) { $stmt = $this->query("SELECT COUNT(*) FROM {$output[1]}"); return (int) $stmt->fetchColumn(); } return NULL; } /** * Create sql for batch insert * * @param string $table * @param mixed $data * @return array<string|array|null> */public function insertBatch(string $table, array $data=[]): array { $data = (array) $data; $firstRow = (array) current($data); // Values for insertion $vals = []; foreach($data as $group) { $vals = array_merge($vals, array_values($group)); } $table = $this->quoteTable($table); $fields = array_keys($firstRow); $sql = "INSERT INTO {$table} (" . implode(',', $this->quoteIdent($fields)) . ') VALUES '; // Create the placeholder groups $params = array_fill(0, count($fields), '?'); $paramString = '(' . implode(',', $params) . ')'; $paramList = array_fill(0, count($data), $paramString); // Append the placeholder groups to the query $sql .= implode(',', $paramList); return [$sql, $vals]; } /** * Creates a batch update, and executes it. * Returns the number of affected rows * * @param string $table The table to update * @param array $data an array of update values * @param string $where The where key * @return array<string,array,int> */public function updateBatch(string $table, array $data, string $where): array { $affectedRows = 0; $insertData = []; $fieldLines = []; $sql = 'UPDATE ' . $this->quoteTable($table) . ' SET '; // Get the keys of the current set of data, except the one used to // set the update condition $fields = array_unique( array_reduce($data, static function ($previous, $current) use (&$affectedRows, $where) { $affectedRows++; $keys = array_diff(array_keys($current), [$where]); if ($previous === NULL) { return $keys; } return array_merge($previous, $keys); }) ); // Create the CASE blocks for each data set foreach ($fields as $field) { $line = $this->quoteIdent($field) . " = CASE\n"; $cases = []; foreach ($data as $case) { if (array_key_exists($field, $case)) { $insertData[] = $case[$where]; $insertData[] = $case[$field]; $cases[] = 'WHEN ' . $this->quoteIdent($where) . ' =? ' . 'THEN ? '; } } $line .= implode("\n", $cases) . "\n"; $line .= 'ELSE ' . $this->quoteIdent($field) . ' END'; $fieldLines[] = $line; } $sql .= implode(",\n", $fieldLines) . "\n"; $whereValues = array_column($data, $where); foreach ($whereValues as $value) { $insertData[] = $value; } // Create the placeholders for the WHERE IN clause $placeholders = array_fill(0, count($whereValues), '?'); $sql .= 'WHERE ' . $this->quoteIdent($where) . ' IN '; $sql .= '(' . implode(',', $placeholders) . ')'; return [$sql, $insertData, $affectedRows]; } /** * Empty the passed table * * @param string $table * @return PDOStatement */public function truncate(string $table): PDOStatement { $sql = $this->hasTruncate ? 'TRUNCATE TABLE ' : 'DELETE FROM '; $sql .= $this->quoteTable($table); $this->statement = $this->query($sql); return $this->statement; } /** * Generate the returning clause for the current database * * @param string $query * @param string $select * @return string */public function returning(string $query, string $select): string { return "{$query} RETURNING {$select}"; } /** * Helper method for quote_ident * * @param mixed $str * @return mixed */public function _quote($str) { // Check that the current value is a string, // and is not already quoted before quoting // that value, otherwise, return the original value return ( is_string($str) && strpos($str, $this->escapeCharOpen) !== 0 && strrpos($str, $this->escapeCharClose) !== 0 ) ? "{$this->escapeCharOpen}{$str}{$this->escapeCharClose}" : $str; } /** * Sets the table prefix on the passed string * * @param string $str * @return string */protected function _prefix(string $str): string { // Don't prefix an already prefixed table if (strpos($str, $this->tablePrefix) !== FALSE) { return $str; } return $this->tablePrefix . $str; } } |