field. * @param mixed $whereValue The value of the database field. * @param string $operator Comparison operator. Default is = * @param string $cond Condition of where statement (OR, AND) * * @return MysqliDb */ public function where($whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') { // forkaround for an old operation api if (is_array($whereValue) && ($key = key($whereValue)) != "0") { $operator = $key; $whereValue = $whereValue[$key]; } if (count($this->_where) == 0) { $cond = ''; } $this->_where[] = array($cond, $whereProp, $operator, $whereValue); return $this; } /** * This function store update column's name and column name of the * autoincrement column * * @param array $updateColumns Variable with values * @param string $lastInsertId Variable value * * @return MysqliDb */ public function onDuplicate($updateColumns, $lastInsertId = null) { $this->_lastInsertId = $lastInsertId; $this->_updateColumns = $updateColumns; return $this; } /** * This method allows you to specify multiple (method chaining optional) OR WHERE statements for SQL queries. * * @uses $MySqliDb->orWhere('id', 7)->orWhere('title', 'MyTitle'); * * @param string $whereProp The name of the database field. * @param mixed $whereValue The value of the database field. * @param string $operator Comparison operator. Default is = * * @return MysqliDb */ public function orWhere($whereProp, $whereValue = 'DBNULL', $operator = '=') { return $this->where($whereProp, $whereValue, $operator, 'OR'); } /** * This method allows you to specify multiple (method chaining optional) AND HAVING statements for SQL queries. * * @uses $MySqliDb->having('SUM(tags) > 10') * * @param string $havingProp The name of the database field. * @param mixed $havingValue The value of the database field. * @param string $operator Comparison operator. Default is = * * @return MysqliDb */ public function having($havingProp, $havingValue = 'DBNULL', $operator = '=', $cond = 'AND') { // forkaround for an old operation api if (is_array($havingValue) && ($key = key($havingValue)) != "0") { $operator = $key; $havingValue = $havingValue[$key]; } if (count($this->_having) == 0) { $cond = ''; } $this->_having[] = array($cond, $havingProp, $operator, $havingValue); return $this; } /** * This method allows you to specify multiple (method chaining optional) OR HAVING statements for SQL queries. * * @uses $MySqliDb->orHaving('SUM(tags) > 10') * * @param string $havingProp The name of the database field. * @param mixed $havingValue The value of the database field. * @param string $operator Comparison operator. Default is = * * @return MysqliDb */ public function orHaving($havingProp, $havingValue = null, $operator = null) { return $this->having($havingProp, $havingValue, $operator, 'OR'); } /** * This method allows you to concatenate joins for the final SQL statement. * * @uses $MySqliDb->join('table1', 'field1 <> field2', 'LEFT') * * @param string $joinTable The name of the table. * @param string $joinCondition the condition. * @param string $joinType 'LEFT', 'INNER' etc. * * @throws Exception * @return MysqliDb */ public function join($joinTable, $joinCondition, $joinType = '') { $allowedTypes = array('LEFT', 'RIGHT', 'OUTER', 'INNER', 'LEFT OUTER', 'RIGHT OUTER'); $joinType = strtoupper(trim($joinType)); if ($joinType && !in_array($joinType, $allowedTypes)) { throw new Exception('Wrong JOIN type: ' . $joinType); } if (!is_object($joinTable)) { $joinTable = self::$prefix . $joinTable; } $this->_join[] = Array($joinType, $joinTable, $joinCondition); return $this; } /** * This is a basic method which allows you to import raw .CSV data into a table * Please check out http://dev.mysql.com/doc/refman/5.7/en/load-data.html for a valid .csv file. * @author Jonas Barascu (Noneatme) * @param string $importTable The database table where the data will be imported into. * @param string $importFile The file to be imported. Please use double backslashes \\ and make sure you * @param string $importSettings An Array defining the import settings as described in the README.md * @return boolean */ public function loadData($importTable, $importFile, $importSettings = null) { // We have to check if the file exists if(!file_exists($importFile)) { // Throw an exception throw new Exception("importCSV -> importFile ".$importFile." does not exists!"); return; } // Define the default values // We will merge it later $settings = Array("fieldChar" => ';', "lineChar" => PHP_EOL, "linesToIgnore" => 1); // Check the import settings if(gettype($importSettings) == "array") { // Merge the default array with the custom one $settings = array_merge($settings, $importSettings); } // Add the prefix to the import table $table = self::$prefix . $importTable; // Add 1 more slash to every slash so maria will interpret it as a path $importFile = str_replace("\\", "\\\\", $importFile); // Build SQL Syntax $sqlSyntax = sprintf('LOAD DATA INFILE \'%s\' INTO TABLE %s', $importFile, $table); // FIELDS $sqlSyntax .= sprintf(' FIELDS TERMINATED BY \'%s\'', $settings["fieldChar"]); if(isset($settings["fieldEnclosure"])) { $sqlSyntax .= sprintf(' ENCLOSED BY \'%s\'', $settings["fieldEnclosure"]); } // LINES $sqlSyntax .= sprintf(' LINES TERMINATED BY \'%s\'', $settings["lineChar"]); if(isset($settings["lineStarting"])) { $sqlSyntax .= sprintf(' STARTING BY \'%s\'', $settings["lineStarting"]); } // IGNORE LINES $sqlSyntax .= sprintf(' IGNORE %d LINES', $settings["linesToIgnore"]); // Exceute the query unprepared because LOAD DATA only works with unprepared statements. $result = $this->queryUnprepared($sqlSyntax); // Are there rows modified? // Let the user know if the import failed / succeeded return (bool) $result; } /** * This method is usefull for importing XML files into a specific table. * Check out the LOAD XML syntax for your MySQL server. * * @author Jonas Barascu * @param string $importTable The table in which the data will be imported to. * @param string $importFile The file which contains the .XML data. * @param string $importSettings An Array defining the import settings as described in the README.md * * @return boolean Returns true if the import succeeded, false if it failed. */ public function loadXml($importTable, $importFile, $importSettings = null) { // We have to check if the file exists if(!file_exists($importFile)) { // Does not exists throw new Exception("loadXml: Import file does not exists"); return; } // Create default values $settings = Array("linesToIgnore" => 0); // Check the import settings if(gettype($importSettings) == "array") { $settings = array_merge($settings, $importSettings); } // Add the prefix to the import table $table = self::$prefix . $importTable; // Add 1 more slash to every slash so maria will interpret it as a path $importFile = str_replace("\\", "\\\\", $importFile); // Build SQL Syntax $sqlSyntax = sprintf('LOAD XML INFILE \'%s\' INTO TABLE %s', $importFile, $table); // FIELDS if(isset($settings["rowTag"])) { $sqlSyntax .= sprintf(' ROWS IDENTIFIED BY \'%s\'', $settings["rowTag"]); } // IGNORE LINES $sqlSyntax .= sprintf(' IGNORE %d LINES', $settings["linesToIgnore"]); // Exceute the query unprepared because LOAD XML only works with unprepared statements. $result = $this->queryUnprepared($sqlSyntax); // Are there rows modified? // Let the user know if the import failed / succeeded return (bool) $result; } /** * This method allows you to specify multiple (method chaining optional) ORDER BY statements for SQL queries. * * @uses $MySqliDb->orderBy('id', 'desc')->orderBy('name', 'desc', '^[a-z]')->orderBy('name', 'desc'); * * @param string $orderByField The name of the database field. * @param string $orderByDirection Order direction. * @param mixed $customFieldsOrRegExp Array with fieldset for ORDER BY FIELD() ordering or string with regular expresion for ORDER BY REGEXP ordering * * @throws Exception * @return MysqliDb */ public function orderBy($orderByField, $orderbyDirection = "DESC", $customFieldsOrRegExp = null) { $allowedDirection = Array("ASC", "DESC"); $orderbyDirection = strtoupper(trim($orderbyDirection)); $orderByField = preg_replace("/[^ -a-z0-9\.\(\),_`\*\'\"]+/i", '', $orderByField); // Add table prefix to orderByField if needed. //FIXME: We are adding prefix only if table is enclosed into `` to distinguish aliases // from table names $orderByField = preg_replace('/(\`)([`a-zA-Z0-9_]*\.)/', '\1' . self::$prefix . '\2', $orderByField); if (empty($orderbyDirection) || !in_array($orderbyDirection, $allowedDirection)) { throw new Exception('Wrong order direction: ' . $orderbyDirection); } if (is_array($customFieldsOrRegExp)) { foreach ($customFieldsOrRegExp as $key => $value) { $customFieldsOrRegExp[$key] = preg_replace("/[^-a-z0-9\.\(\),_` ]+/i", '', $value); } $orderByField = 'FIELD (' . $orderByField . ', "' . implode('","', $customFieldsOrRegExp) . '")'; }elseif(is_string($customFieldsOrRegExp)){ $orderByField = $orderByField . " REGEXP '" . $customFieldsOrRegExp . "'"; }elseif($customFieldsOrRegExp !== null){ throw new Exception('Wrong custom field or Regular Expression: ' . $customFieldsOrRegExp); } $this->_orderBy[$orderByField] = $orderbyDirection; return $this; } /** * This method allows you to specify multiple (method chaining optional) GROUP BY statements for SQL queries. * * @uses $MySqliDb->groupBy('name'); * * @param string $groupByField The name of the database field. * * @return MysqliDb */ public function groupBy($groupByField) { $groupByField = preg_replace("/[^-a-z0-9\.\(\),_\*]+/i", '', $groupByField); $this->_groupBy[] = $groupByField; return $this; } /** * This method sets the current table lock method. * * @author Jonas Barascu * @param string $method The table lock method. Can be READ or WRITE. * * @throws Exception * @return MysqliDb */ public function setLockMethod($method) { // Switch the uppercase string switch(strtoupper($method)) { // Is it READ or WRITE? case "READ" || "WRITE": // Succeed $this->_tableLockMethod = $method; break; default: // Else throw an exception throw new Exception("Bad lock type: Can be either READ or WRITE"); break; } return $this; } /** * Locks a table for R/W action. * * @author Jonas Barascu * @param string $table The table to be locked. Can be a table or a view. * * @throws Exception * @return MysqliDb if succeeeded; */ public function lock($table) { // Main Query $this->_query = "LOCK TABLES"; // Is the table an array? if(gettype($table) == "array") { // Loop trough it and attach it to the query foreach($table as $key => $value) { if(gettype($value) == "string") { if($key > 0) { $this->_query .= ","; } $this->_query .= " ".self::$prefix.$value." ".$this->_tableLockMethod; } } } else{ // Build the table prefix $table = self::$prefix . $table; // Build the query $this->_query = "LOCK TABLES ".$table." ".$this->_tableLockMethod; } // Exceute the query unprepared because LOCK only works with unprepared statements. $result = $this->queryUnprepared($this->_query); $errno = $this->mysqli()->errno; // Reset the query $this->reset(); // Are there rows modified? if($result) { // Return true // We can't return ourself because if one table gets locked, all other ones get unlocked! return true; } // Something went wrong else { throw new Exception("Locking of table ".$table." failed", $errno); } // Return the success value return false; } /** * Unlocks all tables in a database. * Also commits transactions. * * @author Jonas Barascu * @return MysqliDb */ public function unlock() { // Build the query $this->_query = "UNLOCK TABLES"; // Exceute the query unprepared because UNLOCK and LOCK only works with unprepared statements. $result = $this->queryUnprepared($this->_query); $errno = $this->mysqli()->errno; // Reset the query $this->reset(); // Are there rows modified? if($result) { // return self return $this; } // Something went wrong else { throw new Exception("Unlocking of tables failed", $errno); } // Return self return $this; } /** * This methods returns the ID of the last inserted item * * @return int The last inserted item ID. */ public function getInsertId() { return $this->mysqli()->insert_id; } /** * Escape harmful characters which might affect a query. * * @param string $str The string to escape. * * @return string The escaped string. */ public function escape($str) { return $this->mysqli()->real_escape_string($str); } /** * Method to call mysqli->ping() to keep unused connections open on * long-running scripts, or to reconnect timed out connections (if php.ini has * global mysqli.reconnect set to true). Can't do this directly using object * since _mysqli is protected. * * @return bool True if connection is up */ public function ping() { return $this->mysqli()->ping(); } /** * This method is needed for prepared statements. They require * the data type of the field to be bound with "i" s", etc. * This function takes the input, determines what type it is, * and then updates the param_type. * * @param mixed $item Input to determine the type. * * @return string The joined parameter types. */ protected function _determineType($item) { switch (gettype($item)) { case 'NULL': case 'string': return 's'; break; case 'boolean': case 'integer': return 'i'; break; case 'blob': return 'b'; break; case 'double': return 'd'; break; } return ''; } /** * Helper function to add variables into bind parameters array * * @param string Variable value */ protected function _bindParam($value) { $this->_bindParams[0] .= $this->_determineType($value); array_push($this->_bindParams, $value); } /** * Helper function to add variables into bind parameters array in bulk * * @param array $values Variable with values */ protected function _bindParams($values) { foreach ($values as $value) { $this->_bindParam($value); } } /** * Helper function to add variables into bind parameters array and will return * its SQL part of the query according to operator in ' $operator ?' or * ' $operator ($subquery) ' formats * * @param string $operator * @param mixed $value Variable with values * * @return string */ protected function _buildPair($operator, $value) { if (!is_object($value)) { $this->_bindParam($value); return ' ' . $operator . ' ? '; } $subQuery = $value->getSubQuery(); $this->_bindParams($subQuery['params']); return " " . $operator . " (" . $subQuery['query'] . ") " . $subQuery['alias']; } /** * Internal function to build and execute INSERT/REPLACE calls * * @param string $tableName The name of the table. * @param array $insertData Data containing information for inserting into the DB. * @param string $operation Type of operation (INSERT, REPLACE) * * @return bool Boolean indicating whether the insert query was completed succesfully. */ private function _buildInsert($tableName, $insertData, $operation) { if ($this->isSubQuery) { return; } $this->_query = $operation . " " . implode(' ', $this->_queryOptions) . " INTO " . self::$prefix . $tableName; $stmt = $this->_buildQuery(null, $insertData); $status = $stmt->execute(); $this->_stmtError = $stmt->error; $this->_stmtErrno = $stmt->errno; $haveOnDuplicate = !empty ($this->_updateColumns); $this->reset(); $this->count = $stmt->affected_rows; if ($stmt->affected_rows < 1) { // in case of onDuplicate() usage, if no rows were inserted if ($status && $haveOnDuplicate) { return true; } return false; } if ($stmt->insert_id > 0) { return $stmt->insert_id; } return true; } /** * Abstraction method that will compile the WHERE statement, * any passed update data, and the desired rows. * It then builds the SQL query. * * @param int|array $numRows Array to define SQL limit in format Array ($count, $offset) * or only $count * @param array $tableData Should contain an array of data for updating the database. * * @return mysqli_stmt Returns the $stmt object. */ protected function _buildQuery($numRows = null, $tableData = null) { // $this->_buildJoinOld(); $this->_buildJoin(); $this->_buildInsertQuery($tableData); $this->_buildCondition('WHERE', $this->_where); $this->_buildGroupBy(); $this->_buildCondition('HAVING', $this->_having); $this->_buildOrderBy(); $this->_buildLimit($numRows); $this->_buildOnDuplicate($tableData); if ($this->_forUpdate) { $this->_query .= ' FOR UPDATE'; } if ($this->_lockInShareMode) { $this->_query .= ' LOCK IN SHARE MODE'; } $this->_lastQuery = $this->replacePlaceHolders($this->_query, $this->_bindParams); if ($this->isSubQuery) { return; } // Prepare query $stmt = $this->_prepareQuery(); // Bind parameters to statement if any if (count($this->_bindParams) > 1) { call_user_func_array(array($stmt, 'bind_param'), $this->refValues($this->_bindParams)); } return $stmt; } /** * This helper method takes care of prepared statements' "bind_result method * , when the number of variables to pass is unknown. * * @param mysqli_stmt $stmt Equal to the prepared statement object. * * @return array The results of the SQL fetch. */ protected function _dynamicBindResults(mysqli_stmt $stmt) { $parameters = array(); $results = array(); /** * @see http://php.net/manual/en/mysqli-result.fetch-fields.php */ $mysqlLongType = 252; $shouldStoreResult = false; $meta = $stmt->result_metadata(); // if $meta is false yet sqlstate is true, there's no sql error but the query is // most likely an update/insert/delete which doesn't produce any results if (!$meta && $stmt->sqlstate) return array(); $row = array(); while ($field = $meta->fetch_field()) { if ($field->type == $mysqlLongType) { $shouldStoreResult = true; } if ($this->_nestJoin && $field->table != $this->_tableName) { $field->table = substr($field->table, strlen(self::$prefix)); $row[$field->table][$field->name] = null; $parameters[] = & $row[$field->table][$field->name]; } else { $row[$field->name] = null; $parameters[] = & $row[$field->name]; } } // avoid out of memory bug in php 5.2 and 5.3. Mysqli allocates lot of memory for long* // and blob* types. So to avoid out of memory issues store_result is used // https://github.com/joshcam/PHP-MySQLi-Database-Class/pull/119 if ($shouldStoreResult) { $stmt->store_result(); } call_user_func_array(array($stmt, 'bind_result'), $parameters); $this->totalCount = 0; $this->count = 0; while ($stmt->fetch()) { if ($this->returnType == 'object') { $result = new stdClass (); foreach ($row as $key => $val) { if (is_array($val)) { $result->$key = new stdClass (); foreach ($val as $k => $v) { $result->$key->$k = $v; } } else { $result->$key = $val; } } } else { $result = array(); foreach ($row as $key => $val) { if (is_array($val)) { foreach ($val as $k => $v) { $result[$key][$k] = $v; } } else { $result[$key] = $val; } } } $this->count++; if ($this->_mapKey) { $results[$row[$this->_mapKey]] = count($row) > 2 ? $result : end($result); } else { array_push($results, $result); } } if ($shouldStoreResult) { $stmt->free_result(); } $stmt->close(); // stored procedures sometimes can return more then 1 resultset if ($this->mysqli()->more_results()) { $this->mysqli()->next_result(); } if (in_array('SQL_CALC_FOUND_ROWS', $this->_queryOptions)) { $stmt = $this->mysqli()->query('SELECT FOUND_ROWS()'); $totalCount = $stmt->fetch_row(); $this->totalCount = $totalCount[0]; } if ($this->returnType == 'json') { return json_encode($results); } return $results; } /** * Abstraction method that will build an JOIN part of the query * * @return void */ protected function _buildJoinOld() { if (empty($this->_join)) { return; } foreach ($this->_join as $data) { list ($joinType, $joinTable, $joinCondition) = $data; if (is_object($joinTable)) { $joinStr = $this->_buildPair("", $joinTable); } else { $joinStr = $joinTable; } $this->_query .= " " . $joinType . " JOIN " . $joinStr . (false !== stripos($joinCondition, 'using') ? " " : " on ") . $joinCondition; } } /** * Insert/Update query helper * * @param array $tableData * @param array $tableColumns * @param bool $isInsert INSERT operation flag * * @throws Exception */ public function _buildDataPairs($tableData, $tableColumns, $isInsert) { foreach ($tableColumns as $column) { $value = $tableData[$column]; if (!$isInsert) { if(strpos($column,'.')===false) { $this->_query .= "`" . $column . "` = "; } else { $this->_query .= str_replace('.','.`',$column) . "` = "; } } // Subquery value if ($value instanceof MysqliDb) { $this->_query .= $this->_buildPair("", $value) . ", "; continue; } // Simple value if (!is_array($value)) { $this->_bindParam($value); $this->_query .= '?, '; continue; } // Function value $key = key($value); $val = $value[$key]; switch ($key) { case '[I]': $this->_query .= $column . $val . ", "; break; case '[F]': $this->_query .= $val[0] . ", "; if (!empty($val[1])) { $this->_bindParams($val[1]); } break; case '[N]': if ($val == null) { $this->_query .= "!" . $column . ", "; } else { $this->_query .= "!" . $val . ", "; } break; default: throw new Exception("Wrong operation"); } } $this->_query = rtrim($this->_query, ', '); } /** * Helper function to add variables into the query statement * * @param array $tableData Variable with values */ protected function _buildOnDuplicate($tableData) { if (is_array($this->_updateColumns) && !empty($this->_updateColumns)) { $this->_query .= " ON DUPLICATE KEY UPDATE "; if ($this->_lastInsertId) { $this->_query .= $this->_lastInsertId . "=LAST_INSERT_ID (" . $this->_lastInsertId . "), "; } foreach ($this->_updateColumns as $key => $val) { // skip all params without a value if (is_numeric($key)) { $this->_updateColumns[$val] = ''; unset($this->_updateColumns[$key]); } else { $tableData[$key] = $val; } } $this->_buildDataPairs($tableData, array_keys($this->_updateColumns), false); } } /** * Abstraction method that will build an INSERT or UPDATE part of the query * * @param array $tableData */ protected function _buildInsertQuery($tableData) { if (!is_array($tableData)) { return; } $isInsert = preg_match('/^[INSERT|REPLACE]/', $this->_query); $dataColumns = array_keys($tableData); if ($isInsert) { if (isset ($dataColumns[0])) $this->_query .= ' (`' . implode($dataColumns, '`, `') . '`) '; $this->_query .= ' VALUES ('; } else { $this->_query .= " SET "; } $this->_buildDataPairs($tableData, $dataColumns, $isInsert); if ($isInsert) { $this->_query .= ')'; } } /** * Abstraction method that will build the part of the WHERE conditions * * @param string $operator * @param array $conditions */ protected function _buildCondition($operator, &$conditions) { if (empty($conditions)) { return; } //Prepare the where portion of the query $this->_query .= ' ' . $operator; foreach ($conditions as $cond) { list ($concat, $varName, $operator, $val) = $cond; $this->_query .= " " . $concat . " " . $varName; switch (strtolower($operator)) { case 'not in': case 'in': $comparison = ' ' . $operator . ' ('; if (is_object($val)) { $comparison .= $this->_buildPair("", $val); } else { foreach ($val as $v) { $comparison .= ' ?,'; $this->_bindParam($v); } } $this->_query .= rtrim($comparison, ',') . ' ) '; break; case 'not between': case 'between': $this->_query .= " $operator ? AND ? "; $this->_bindParams($val); break; case 'not exists': case 'exists': $this->_query.= $operator . $this->_buildPair("", $val); break; default: if (is_array($val)) { $this->_bindParams($val); } elseif ($val === null) { $this->_query .= ' ' . $operator . " NULL"; } elseif ($val != 'DBNULL' || $val == '0') { $this->_query .= $this->_buildPair($operator, $val); } } } } /** * Abstraction method that will build the GROUP BY part of the WHERE statement * * @return void */ protected function _buildGroupBy() { if (empty($this->_groupBy)) { return; } $this->_query .= " GROUP BY "; foreach ($this->_groupBy as $key => $value) { $this->_query .= $value . ", "; } $this->_query = rtrim($this->_query, ', ') . " "; } /** * Abstraction method that will build the LIMIT part of the WHERE statement * * @return void */ protected function _buildOrderBy() { if (empty($this->_orderBy)) { return; } $this->_query .= " ORDER BY "; foreach ($this->_orderBy as $prop => $value) { if (strtolower(str_replace(" ", "", $prop)) == 'rand()') { $this->_query .= "rand(), "; } else { $this->_query .= $prop . " " . $value . ", "; } } $this->_query = rtrim($this->_query, ', ') . " "; } /** * Abstraction method that will build the LIMIT part of the WHERE statement * * @param int|array $numRows Array to define SQL limit in format Array ($count, $offset) * or only $count * * @return void */ protected function _buildLimit($numRows) { if (!isset($numRows)) { return; } if (is_array($numRows)) { $this->_query .= ' LIMIT ' . (int) $numRows[0] . ', ' . (int) $numRows[1]; } else { $this->_query .= ' LIMIT ' . (int) $numRows; } } /** * Method attempts to prepare the SQL query * and throws an error if there was a problem. * * @return mysqli_stmt * @throws Exception */ protected function _prepareQuery() { if (!$stmt = $this->mysqli()->prepare($this->_query)) { $msg = $this->mysqli()->error . " query: " . $this->_query; $num = $this->mysqli()->errno; $this->reset(); throw new Exception($msg, $num); } if ($this->traceEnabled) { $this->traceStartQ = microtime(true); } return $stmt; } /** * Referenced data array is required by mysqli since PHP 5.3+ * * @param array $arr * * @return array */ protected function refValues(array &$arr) { //Reference in the function arguments are required for HHVM to work //https://github.com/facebook/hhvm/issues/5155 //Referenced data array is required by mysqli since PHP 5.3+ if (strnatcmp(phpversion(), '5.3') >= 0) { $refs = array(); foreach ($arr as $key => $value) { $refs[$key] = & $arr[$key]; } return $refs; } return $arr; } /** * Function to replace ? with variables from bind variable * * @param string $str * @param array $vals * * @return string */ protected function replacePlaceHolders($str, $vals) { $i = 1; $newStr = ""; if (empty($vals)) { return $str; } while ($pos = strpos($str, "?")) { $val = $vals[$i++]; if (is_object($val)) { $val = '[object]'; } if ($val === null) { $val = 'NULL'; } $newStr .= substr($str, 0, $pos) . "'" . $val . "'"; $str = substr($str, $pos + 1); } $newStr .= $str; return $newStr; } /** * Method returns last executed query * * @return string */ public function getLastQuery() { return $this->_lastQuery; } /** * Method returns mysql error * * @return string */ public function getLastError() { if (!isset($this->_mysqli[$this->defConnectionName])) { return "mysqli is null"; } return trim($this->_stmtError . " " . $this->mysqli()->error); } /** * Method returns mysql error code * @return int */ public function getLastErrno () { return $this->_stmtErrno; } /** * Mostly internal method to get query and its params out of subquery object * after get() and getAll() * * @return array */ public function getSubQuery() { if (!$this->isSubQuery) { return null; } array_shift($this->_bindParams); $val = Array('query' => $this->_query, 'params' => $this->_bindParams, 'alias' => isset($this->connectionsSettings[$this->defConnectionName]) ? $this->connectionsSettings[$this->defConnectionName]['host'] : null ); $this->reset(); return $val; } /* Helper functions */ /** * Method returns generated interval function as a string * * @param string $diff interval in the formats: * "1", "-1d" or "- 1 day" -- For interval - 1 day * Supported intervals [s]econd, [m]inute, [h]hour, [d]day, [M]onth, [Y]ear * Default null; * @param string $func Initial date * * @return string */ public function interval($diff, $func = "NOW()") { $types = Array("s" => "second", "m" => "minute", "h" => "hour", "d" => "day", "M" => "month", "Y" => "year"); $incr = '+'; $items = ''; $type = 'd'; if ($diff && preg_match('/([+-]?) ?([0-9]+) ?([a-zA-Z]?)/', $diff, $matches)) { if (!empty($matches[1])) { $incr = $matches[1]; } if (!empty($matches[2])) { $items = $matches[2]; } if (!empty($matches[3])) { $type = $matches[3]; } if (!in_array($type, array_keys($types))) { throw new Exception("invalid interval type in '{$diff}'"); } $func .= " " . $incr . " interval " . $items . " " . $types[$type] . " "; } return $func; } /** * Method returns generated interval function as an insert/update function * * @param string $diff interval in the formats: * "1", "-1d" or "- 1 day" -- For interval - 1 day * Supported intervals [s]econd, [m]inute, [h]hour, [d]day, [M]onth, [Y]ear * Default null; * @param string $func Initial date * * @return array */ public function now($diff = null, $func = "NOW()") { return array("[F]" => Array($this->interval($diff, $func))); } /** * Method generates incremental function call * * @param int $num increment by int or float. 1 by default * * @throws Exception * @return array */ public function inc($num = 1) { if (!is_numeric($num)) { throw new Exception('Argument supplied to inc must be a number'); } return array("[I]" => "+" . $num); } /** * Method generates decrimental function call * * @param int $num increment by int or float. 1 by default * * @return array */ public function dec($num = 1) { if (!is_numeric($num)) { throw new Exception('Argument supplied to dec must be a number'); } return array("[I]" => "-" . $num); } /** * Method generates change boolean function call * * @param string $col column name. null by default * * @return array */ public function not($col = null) { return array("[N]" => (string) $col); } /** * Method generates user defined function call * * @param string $expr user function body * @param array $bindParams * * @return array */ public function func($expr, $bindParams = null) { return array("[F]" => array($expr, $bindParams)); } /** * Method creates new mysqlidb object for a subquery generation * * @param string $subQueryAlias * * @return MysqliDb */ public static function subQuery($subQueryAlias = "") { return new self(array('host' => $subQueryAlias, 'isSubQuery' => true)); } /** * Method returns a copy of a mysqlidb subquery object * * @return MysqliDb new mysqlidb object */ public function copy() { $copy = unserialize(serialize($this)); $copy->_mysqli = array(); return $copy; } /** * Begin a transaction * * @uses mysqli->autocommit(false) * @uses register_shutdown_function(array($this, "_transaction_shutdown_check")) */ public function startTransaction() { $this->mysqli()->autocommit(false); $this->_transaction_in_progress = true; register_shutdown_function(array($this, "_transaction_status_check")); } /** * Transaction commit * * @uses mysqli->commit(); * @uses mysqli->autocommit(true); */ public function commit() { $result = $this->mysqli()->commit(); $this->_transaction_in_progress = false; $this->mysqli()->autocommit(true); return $result; } /** * Transaction rollback function * * @uses mysqli->rollback(); * @uses mysqli->autocommit(true); */ public function rollback() { $result = $this->mysqli()->rollback(); $this->_transaction_in_progress = false; $this->mysqli()->autocommit(true); return $result; } /** * Shutdown handler to rollback uncommited operations in order to keep * atomic operations sane. * * @uses mysqli->rollback(); */ public function _transaction_status_check() { if (!$this->_transaction_in_progress) { return; } $this->rollback(); } /** * Query exection time tracking switch * * @param bool $enabled Enable execution time tracking * @param string $stripPrefix Prefix to strip from the path in exec log * * @return MysqliDb */ public function setTrace($enabled, $stripPrefix = null) { $this->traceEnabled = $enabled; $this->traceStripPrefix = $stripPrefix; return $this; } /** * Get where and what function was called for query stored in MysqliDB->trace * * @return string with information */ private function _traceGetCaller() { $dd = debug_backtrace(); $caller = next($dd); while (isset($caller) && $caller["file"] == __FILE__) { $caller = next($dd); } return __CLASS__ . "->" . $caller["function"] . "() >> file \"" . str_replace($this->traceStripPrefix, '', $caller["file"]) . "\" line #" . $caller["line"] . " "; } /** * Method to check if needed table is created * * @param array $tables Table name or an Array of table names to check * * @return bool True if table exists */ public function tableExists($tables) { $tables = !is_array($tables) ? Array($tables) : $tables; $count = count($tables); if ($count == 0) { return false; } foreach ($tables as $i => $value) $tables[$i] = self::$prefix . $value; $db = isset($this->connectionsSettings[$this->defConnectionName]) ? $this->connectionsSettings[$this->defConnectionName]['db'] : null; $this->where('table_schema', $db); $this->where('table_name', $tables, 'in'); $this->get('information_schema.tables', $count); return $this->count == $count; } /** * Return result as an associative array with $idField field value used as a record key * * Array Returns an array($k => $v) if get(.."param1, param2"), array ($k => array ($v, $v)) otherwise * * @param string $idField field name to use for a mapped element key * * @return MysqliDb */ public function map($idField) { $this->_mapKey = $idField; return $this; } /** * Pagination wraper to get() * * @access public * @param string $table The name of the database table to work with * @param int $page Page number * @param array|string $fields Array or coma separated list of fields to fetch * @return array */ public function paginate ($table, $page, $fields = null) { $offset = $this->pageLimit * ($page - 1); $res = $this->withTotalCount()->get ($table, Array ($offset, $this->pageLimit), $fields); $this->totalPages = ceil($this->totalCount / $this->pageLimit); return $res; } /** * This method allows you to specify multiple (method chaining optional) AND WHERE statements for the join table on part of the SQL query. * * @uses $dbWrapper->joinWhere('user u', 'u.id', 7)->where('user u', 'u.title', 'MyTitle'); * * @param string $whereJoin The name of the table followed by its prefix. * @param string $whereProp The name of the database field. * @param mixed $whereValue The value of the database field. * * @return dbWrapper */ public function joinWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') { $this->_joinAnd[$whereJoin][] = Array ($cond, $whereProp, $operator, $whereValue); return $this; } /** * This method allows you to specify multiple (method chaining optional) OR WHERE statements for the join table on part of the SQL query. * * @uses $dbWrapper->joinWhere('user u', 'u.id', 7)->where('user u', 'u.title', 'MyTitle'); * * @param string $whereJoin The name of the table followed by its prefix. * @param string $whereProp The name of the database field. * @param mixed $whereValue The value of the database field. * * @return dbWrapper */ public function joinOrWhere($whereJoin, $whereProp, $whereValue = 'DBNULL', $operator = '=', $cond = 'AND') { return $this->joinWhere($whereJoin, $whereProp, $whereValue, $operator, 'OR'); } /** * Abstraction method that will build an JOIN part of the query */ protected function _buildJoin () { if (empty ($this->_join)) return; foreach ($this->_join as $data) { list ($joinType, $joinTable, $joinCondition) = $data; if (is_object ($joinTable)) $joinStr = $this->_buildPair ("", $joinTable); else $joinStr = $joinTable; $this->_query .= " " . $joinType. " JOIN " . $joinStr ." on " . $joinCondition; // Add join and query if (!empty($this->_joinAnd) && isset($this->_joinAnd[$joinStr])) { foreach($this->_joinAnd[$joinStr] as $join_and_cond) { list ($concat, $varName, $operator, $val) = $join_and_cond; $this->_query .= " " . $concat ." " . $varName; $this->conditionToSql($operator, $val); } } } } /** * Convert a condition and value into the sql string * @param String $operator The where constraint operator * @param String $val The where constraint value */ private function conditionToSql($operator, $val) { switch (strtolower ($operator)) { case 'not in': case 'in': $comparison = ' ' . $operator. ' ('; if (is_object ($val)) { $comparison .= $this->_buildPair ("", $val); } else { foreach ($val as $v) { $comparison .= ' ?,'; $this->_bindParam ($v); } } $this->_query .= rtrim($comparison, ',').' ) '; break; case 'not between': case 'between': $this->_query .= " $operator ? AND ? "; $this->_bindParams ($val); break; case 'not exists': case 'exists': $this->_query.= $operator . $this->_buildPair ("", $val); break; default: if (is_array ($val)) $this->_bindParams ($val); else if ($val === null) $this->_query .= $operator . " NULL"; else if ($val != 'DBNULL' || $val == '0') $this->_query .= $this->_buildPair ($operator, $val); } } } // END class ?>