Class Core_DataBase

Abstract DataBase

Direct known subclasses

Core_DataBase_Mysql, Core_DataBase_Pdo

Abstract
Package: HostCMS\Core\Database
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
Located at core/database.php

Methods summary

`abstract public boolean`	# `connect( )` Connect to the database Connect to the database Returns boolean
`abstract public Core_DataBase`	# `disconnect( )` Close connection Close connection Returns `Core_DataBase`
`abstract public string\|null`	# `getVersion( )` Get database version Get database version Returns string\|null
`abstract public Core_DataBase`	# `setCharset( string $charset )` Set the client character set Set the client character set Parameters `$charset` A valid character set name. Returns `Core_DataBase`
`abstract public string`	# `escape( string $unescapedString )` Escapes special characters in a string for use in an SQL statement Escapes special characters in a string for use in an SQL statement Parameters `$unescapedString` The string that is to be escaped Returns string Escaped string
`abstract public array`	# `getTables( mixed $selectionCondition = NULL )` Get list of tables in the database Get list of tables in the database Parameters `$selectionCondition` Selection condition Returns array
`abstract public array`	# `getTablesSchema( mixed $selectionCondition = NULL )` Get tables schema in the database Get tables schema in the database Parameters `$selectionCondition` Selection condition Returns array
`abstract protected array`	# `_fetch( $result, boolean $bCache = TRUE )` Fetch query result Fetch query result Parameters `$result` resource `$bCache` use cache Returns array
`public array`	# `getColumns( string $tableName, mixed $selectionCondition = NULL )` Get list of columns in the table Get list of columns in the table Parameters `$tableName` Table name `$selectionCondition` Selection condition Returns array See `Core_DataBase::getFullColumns()`
`public array`	# `getFullColumns( string $tableName, mixed $selectionCondition = NULL )` Get list of columns in the table Get list of columns in the table Parameters `$tableName` Table name `$selectionCondition` Selection condition Returns array
`public array`	# `getIndexes( string $tableName, mixed $selectionCondition = NULL )` Get list of indexes in the table Get list of indexes in the table Parameters `$tableName` Table name `$selectionCondition` Selection condition Returns array
`abstract public string`	# `quoteColumnName( mixed $columnName )` Quote column name, e.g. `columnName` for 'columnName', `columnName` AS `columnNameAlias` for array('columnName', 'columnNameAlias') Quote column name, e.g. `columnName` for 'columnName', `columnName` AS `columnNameAlias` for array('columnName', 'columnNameAlias') Parameters `$columnName` string\|array Returns string
`abstract public string`	# `quoteTableName( mixed $tableName )` Quote table name, e.g. `tableName` for 'tableName', `tableName` AS `tableNameAlias` for array('tableName', 'tableNameAlias') Quote table name, e.g. `tableName` for 'tableName', `tableName` AS `tableNameAlias` for array('tableName', 'tableNameAlias') Parameters `$tableName` $columnName string\|array Returns string
`abstract public Core_DataBase`	# `begin( string $IsolationLevel = NULL )` Start SQL-transaction Start SQL-transaction Parameters `$IsolationLevel` Transaction isolation level Returns `Core_DataBase`
`abstract public Core_DataBase`	# `commit( )` Commit SQL-transaction Commit SQL-transaction Returns `Core_DataBase`
`abstract public Core_DataBase`	# `rollback( )` Rollback SQL-transaction Rollback SQL-transaction Returns `Core_DataBase`
`abstract public Core_DataBase`	# `query( string $sql )` Send a MySQL query Send a MySQL query Parameters `$sql` An SQL query. The query string should not end with a semicolon. Data inside the query should be properly escaped. Returns `Core_DataBase`
`abstract public array`	# `result( boolean $bCache = TRUE )` Get last query result rows as an array of associative arrays or as an array of objects Get last query result rows as an array of associative arrays or as an array of objects Parameters `$bCache` use cache Returns array See `Core_DataBase::current()`
`abstract public resource`	# `getResult( )` Get last query result as resource Get last query result as resource Returns resource
`abstract public Core_DataBase`	# `asAssoc( )` Set result type as an array Set result type as an array Returns `Core_DataBase`
`abstract public Core_DataBase`	# `asObject( mixed $className = NULL )` Set result type as an object with className Set result type as an object with className Parameters `$className` Object class name Returns `Core_DataBase`
`abstract public mixed`	# `current( boolean $bCache = TRUE )` Get next row for last query result as an associative array or as an object Get next row for last query result as an associative array or as an object Parameters `$bCache` use cache Returns mixed array or object See `Core_DataBase::asAssoc()` `Core_DataBase::asObject()` `Core_DataBase::result()`
`abstract public integer\|null`	# `getInsertId( )` Get the ID generated in the last query Get the ID generated in the last query Returns integer\|null
`abstract public integer\|null`	# `getAffectedRows( )` Get number of affected rows in previous MySQL operation Get number of affected rows in previous MySQL operation Returns integer\|null number of affected rows or NULL
`abstract public integer\|null`	# `getColumnCount( )` Returns the number of columns in the result set Returns the number of columns in the result set Returns integer\|null number of columns in the result set
`abstract public Core_DataBase`	# `free( )` Free last result memory Free last result memory Returns `Core_DataBase`
`public string`	# `highlightSql( string $sql )` Highlight SQL Highlight SQL Parameters `$sql` SQL Returns string SQL
`public Core_DataBase`	# `setQueryType( integer $queryType )` Set type of query Set type of query Parameters `$queryType` Returns `Core_DataBase`
`public integer`	# `getQueryType( )` Get type of query Get type of query Returns integer
`public`	# `__construct( array $config )` Constructor. Constructor. Parameters `$config` config
`public Core_DataBase`	# `setConfig( array $config )` Set database config Set database config Parameters `$config` config Returns `Core_DataBase`
`public array`	# `getConfig( )` Get current config array (without username and password) Get current config array (without username and password) Returns array
`public Core_DataBase`	# `unbuffered( boolean $unbuffered )` Query without fetching and buffering the result rows Query without fetching and buffering the result rows Parameters `$unbuffered` Returns `Core_DataBase`
`public`	# `__destruct( )` Destructor Destructor
`protected static srting`	# `_getDriverName( string $driver )` Get full driver name Get full driver name Parameters `$driver` driver name Returns srting
`public static object`	# `instance( string $name = 'default' )` Register an existing instance as a singleton. Register an existing instance as a singleton. Parameters `$name` driver's name Returns object
`public string`	# `quote( mixed $value )` Convert and escape value for SQL query. Convert and escape value for SQL query. Parameters `$value` Returns string
`public`	# `dump( string $tableName, Core_Out $stdOut )` Create table $tableName dump Create table $tableName dump Parameters `$tableName` `$stdOut` return Core_DataBase
`public array`	# `getColumnTypeAndLength( string $columnType )` Split column type into type and length Split column type into type and length Parameters `$columnType` column type Returns array 0 => type, 1 => length
`public array`	# `getColumnType( string $columnType )` Get database colimn type Get database colimn type Parameters `$columnType` Returns array
`public string`	# `getLastQuery( )` Get last query Get last query Returns string
`public string`	# `escapeLike( string $value )` Escape value in LIKE conditions Escape value in LIKE conditions Parameters `$value` Returns string
`public array`	# `getCollations( )` Get Collations Get Collations Returns array array[Charset] => array of collations

Properties summary

`public static mixed`	`$instance` The singleton instances. The singleton instances.	# `array()`
`protected`	`$_config` Driver's configuration Driver's configuration	# `NULL`
`protected`	`$_connection` Driver's connection Driver's connection	# `NULL`
`protected`	`$_lastQuery` Last executed query Last executed query	# `NULL`
`protected`	`$_queryType` Type of query: 0 - SELECT 1 - INSERT 2 - UPDATE 3 - DELETE 4 - RENAME 5 - ALTER 6 - DROP 7 - TRUNCATE 8 - OPTIMIZE 9 - SHOW 10 - LOCK 99 - OTHER Type of query: 0 - SELECT 1 - INSERT 2 - UPDATE 3 - DELETE 4 - RENAME 5 - ALTER 6 - DROP 7 - TRUNCATE 8 - OPTIMIZE 9 - SHOW 10 - LOCK 99 - OTHER	# `NULL`
`protected boolean`	`$_asObject` Get result as object Get result as object	# `FALSE`
`protected string`	`$_columnQuoteCharacter`	# '`'
`protected string`	`$_tableQuoteCharacter`	# '`'
`protected array`	`$_separator` Array of allowed separators, e.g. table.field => `table`.`field`, a + b => `a` + `b` Array of allowed separators, e.g. table.field => `table`.`field`, a + b => `a` + `b`	# `array('.', ' + ', ' - ', ' / ', ' * ')`
`protected static array`	`$_colors` Colors array Colors array	# `array( 'orange' , 'blue' , 'green' , 'brown' )`
`protected static array`	`$_words` Words array Words array	# array( array('AND', 'IS', '&&', 'LOG', 'NOT','NOW', 'MIN', '!', '\\|\\|', 'OR', 'OCT', 'TAN', 'STD', 'SHA', 'ORD', 'XOR', 'ASC', 'DESC'), array('SELECT', 'UPDATE', 'INSERT', 'DELETE', 'USING', 'LIMIT', 'OFFSET', 'SET' ), array('DATE', 'INTO', 'FROM', 'THEN', 'WHEN', 'WHERE', 'LEFT JOIN', 'LEFT OUTER JOIN', 'RIGHT JOIN', 'RIGHT OUTER JOIN', 'INNER JOIN', 'JOIN', 'ELSE', 'ORDER BY', 'GROUP BY', 'HAVING', 'ON'), array('ABS', 'ACOS', 'ADDDATE', 'ADDTIME', 'AES_DECRYPT', 'AES_ENCRYPT', '&&', 'ASCII', 'ASIN', 'ATAN2', 'ATAN', 'AVG', 'BETWEEN', 'BIN', 'BINARY', 'BIT_AND', 'BIT_LENGTH', 'BIT_OR', 'BIT_XOR', 'CASE', 'CAST', 'CEIL', 'CEILING', 'CHAR_LENGTH', 'CHAR', 'CHARACTER_LENGTH', 'CHARSET', 'COALESCE', 'COERCIBILITY', 'COLLATION', 'COMPRESS', 'CONCAT_WS', 'CONCAT', 'CONNECTION_ID', 'CONV', 'CONVERT_TZ', 'Convert', 'COS', 'COT', 'COUNT', 'COUNT', 'COUNT(DISTINCT)', 'DISTINCT', 'CRC32', 'CURDATE', 'CURRENT_DATE', 'CURRENT_TIME', 'CURRENT_TIMESTAMP', 'CURRENT_USER', 'CURTIME', 'DATABASE', 'DATE_ADD', 'DATE_FORMAT', 'DATE_SUB', 'DATEDIFF', 'DAY ', 'DAYNAME', 'DAYOFMONTH', 'DAYOFWEEK', 'DAYOFYEAR', 'DECODE', 'DEFAULT', 'DEGREES', 'DES_DECRYPT', 'DES_ENCRYPT', 'DIV', 'ELT', 'ENCODE', 'ENCRYPT', '<=>', 'EXP()', 'EXPORT_SET', 'EXTRACT', 'FIELD', 'FIND_IN_SET', 'FLOOR', 'FORMAT', 'SQL_CALC_FOUND_ROWS ', 'FOUND_ROWS', 'STRAIGHT_JOIN', 'FROM_DAYS', 'FROM_UNIXTIME', 'GET_FORMAT', 'GET_LOCK', 'GREATEST', 'GROUP_CONCAT', 'HEX ', 'HOUR', ' IF ', 'IFNULL', ' IN ', 'INET_ATON', 'INET_NTOA', 'INSTR', 'IS_FREE_LOCK', 'IS NOT NULL', 'IS NOT', 'IS NULL', 'IS_USED_LOCK', 'ISNULL', 'LAST_DAY', 'LAST_INSERT_ID', 'LCASE', 'LEAST', '<<', 'LEFT', 'LENGTH', 'LIKE', 'LN', 'LOAD_FILE', 'LOCALTIME', 'LOCALTIMESTAMP', 'LOCATE', 'LOG10', 'LOG2', 'LOWER', 'LPAD', 'LTRIM', 'MAKE_SET', 'MAKEDATE', 'MAKETIME', 'MASTER_POS_WAIT', 'MATCH', 'MAX', 'MD5', 'MICROSECOND', 'MID', 'MINUTE', 'MOD', '%', 'MONTH', 'MONTHNAME', 'NOT BETWEEN', '!=', 'NOT IN', 'NOT LIKE', 'NOT REGEXP', 'NULLIF', 'OCTET_LENGTH', 'OLD_PASSWORD', 'ORD', 'PASSWORD', 'PERIOD_ADD', 'PERIOD_DIFF', 'PI', '\+', 'POSITION', 'POW', 'POWER', 'PROCEDURE ANALYSE', 'QUARTER', 'QUOTE', 'RADIANS', 'RAND', 'REGEXP', 'RELEASE_LOCK', 'REPEAT', 'REPLACE', 'REVERSE', '>>', 'RIGHT', 'RLIKE', 'ROUND', 'ROW_COUN', 'RPAD', 'RTRIM', 'SCHEMA', 'SEC_TO_TIME', 'SECOND', 'SESSION_USER', 'SHA1', 'SIGN', 'SLEEP', 'SOUNDEX', 'SOUNDS LIKE', 'SPACE', 'SQRT', 'STDDEV_POP', 'STDDEV_SAMP', 'STDDEV', 'STR_TO_DATE', 'SUBDATE', 'SUBSTR', 'SUBSTRING_INDEX', 'SUBSTRING', 'SUBTIME', 'SUM', 'SYSDATE', 'SYSTEM_USER', 'TIME_FORMAT', 'TIME_TO_SEC', 'TIME', 'TIMEDIFF', '\*', 'TIMESTAMP', 'TIMESTAMPADD', 'TIMESTAMPDIFF', 'TO_DAYS', 'TRIM', 'TRUNCATE', 'UCASE', 'UNCOMPRESS', 'UNCOMPRESSED_LENGTH', 'UNHEX', 'UNIX_TIMESTAMP', 'UPPER', 'USER', 'UTC_DATE', 'UTC_TIME', 'UTC_TIMESTAMP', 'UUID', 'VALUES', 'VAR_POP', 'VAR_SAMP', 'VARIANCE', 'VERSION', 'WEEK', 'WEEKDAY', 'WEEKOFYEAR', 'YEAR', 'YEARWEE') )
`protected boolean`	`$_unbuffered` Query without fetching and buffering the result rows Query without fetching and buffering the result rows	# `FALSE`
`protected array`	`$_likeReplacements` Array of replacements for LIKE Array of replacements for LIKE	# `array( '%' => '\%', '_' => '\_', '\\' => '\\\\' )`
`protected null\|array`	`$_collations` Cache for getCollations() Cache for getCollations()	# `NULL`

Classes

Exceptions

Functions

Class Core_DataBase

Direct known subclasses

Methods summary

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Returns

Parameters

Returns

Parameters

Returns

See

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Properties summary