• Главная
• DboSource

PHP Класс DboSource

Creates DBO-descendant objects from a given db connection configuration Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$affected	string	String to hold how many rows were affected by the last SQL operation.
$alias	string	Database keyword used to assign aliases to identifiers.
$cacheMethods	boolean	Whether or not to cache the results of DboSource::name() and DboSource::conditions() into the memory cache. Set to false to disable the use of the memory cache.
$configKeyName	string	The DataSource configuration key name
$description	string	Description string for this Database Data Source.
$endQuote	string	The ending character that this DataSource uses for quoted identifiers.
$fieldParameters	array	List of engine specific additional field parameters used on table creating
$fullDebug	boolean	Print full query debug info?
$index	array	index definition, standard cake, primary, index, unique
$methodCache	array	Caches result from query parsing operations. Cached results for both DboSource::name() and DboSource::conditions() will be stored here. Method caching uses md5(). If you have problems with collisions, set DboSource::$cacheMethods to false.
$numRows	integer	Number of rows in current resultset
$startQuote	string	The starting character that this DataSource uses for quoted identifiers.
$tableParameters	array	List of table engine specific parameters used on table creating
$took	integer	Time the last query took
$useNestedTransactions	boolean	Flag to support nested transactions. If it is set to false, you will be able to use the transaction methods (begin/commit/rollback), but just the global transaction will be executed.
$virtualFieldSeparator	string	Separator string for virtualField composition

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_connection	array	A reference to the physical connection of this DataSource
$_encodingMaps	array	PHP←→DBエンコーディングマップ
$_methodCacheChange	boolean	Indicates whether there was a change on the cached results on the methods of this class This will be used for storing in a more persistent cache
$_queriesCnt	integer	Queries count.
$_queriesLog	array	Log of queries executed by this DataSource
$_queriesLogMax	integer	This is to prevent query log taking over too much memory.
$_queriesTime	integer	Total duration of all queries.
$_queryCache	array	Caches serialized results of executed queries
$_queryDefaults	array	Default fields that are used by the DBO
$_result	array	Result
$_sqlOps	array	The set of valid SQL operations usable in a WHERE statement
$_transactionNesting	integer	Indicates the level of nested transactions

Открытые методы

Метод	Описание
__construct ( array $config = null, boolean $autoConnect = true )	Constructor
__destruct ( )	Used for storing in cache the results of the in-memory methodCache
addColumn ( array $options ) : boolean	カラムを追加する
alterSchema ( mixed $compare, string $table = null ) : boolean	Generate a alter syntax from CakeSchema::compare()
alterTable ( array $options ) : boolean	テーブル構造を変更する
alterTableBySchema ( array $options ) : boolean	スキーマファイルからテーブル構造を変更する
begin ( ) : boolean	Begin a transaction
boolean ( mixed $data, boolean $quote = false ) : string | boolean	Translates between PHP boolean values and Database (faked) boolean values
buildAssociationQuery ( Model $Model, array $queryData ) : string	Builds an SQL statement.
buildColumn ( array $column ) : string	Generate a database-native column schema string
buildIndex ( array $indexes, string $table = null ) : array	Format indexes for create table.
buildJoinStatement ( array $join ) : string	Builds and generates a JOIN condition from an array. Handles final clean-up before conversion.
buildRenameTable ( string $sourceName, string $targetName ) : string	テーブル名のリネームステートメントを生成
buildStatement ( array $query, Model $Model ) : string	Builds and generates an SQL statement from an array. Handles final clean-up before conversion.
buildTableParameters ( array $parameters, string $table = null ) : array	Format parameters for create table
cacheMethod ( string $method, string $key, mixed $value = null ) : mixed	Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods.
calculate ( Model $Model, string $func, array $params = [] ) : string	Returns an SQL calculation, i.e. COUNT() or MAX()
changeColumn ( array $options ) : boolean	カラムを変更する
close ( ) : void	Disconnects database, kills the connection and says the connection is closed.
commit ( ) : boolean	Commit a transaction
conditionKeysToString ( array $conditions, boolean $quoteValues = true, Model $Model = null ) : string	Creates a WHERE clause by parsing given conditions array. Used by DboSource::conditions().
conditions ( mixed $conditions, boolean $quoteValues = true, boolean $where = true, Model $Model = null ) : string	Creates a WHERE clause by parsing given conditions data. If an array or string conditions are provided those conditions will be parsed and quoted. If a boolean is given it will be integer cast as condition. Null will return 1 = 1.
create ( Model $Model, array $fields = null, array $values = null ) : boolean	The "C" in CRUD
createSchema ( CakeSchema $schema, string $tableName = null ) : string	Generate a database-native schema for the given Schema object
createTable ( array $options ) : boolean	テーブルを作成する
createTableBySchema ( array $options ) : boolean	スキーマファイルからテーブルを生成する
defaultConditions ( Model $Model, string | array | boolean $conditions, boolean $useAlias = true ) : mixed	Creates a default set of conditions from the model if $conditions is null/empty.
delete ( Model $Model, mixed $conditions = null ) : boolean	Generates and executes an SQL DELETE statement.
disconnect ( ) : boolean	Disconnects from database.
dropColumn ( array $options ) : boolean	カラムを削除する
dropSchema ( CakeSchema $schema, string $table = null ) : string	Generate a "drop table" statement for the given Schema object
dropTable ( array $options ) : boolean	テーブルを削除する
dropTableBySchema ( $options ) : boolean	スキーマファイルからテーブルを削除する
execute ( string $sql, array $options = [], array $params = [] ) : mixed	Queries the database with given SQL statement, and obtains some metadata about the result (rows affected, timing, any errors, number of rows in resultset). The query is also logged.
expression ( string $expression ) : stdClass	Returns an object to represent a database expression in a query. Expression objects are not sanitized or escaped.
fetchAll ( string $sql, array | boolean $params = [], array $options = [] ) : boolean | array	Returns an array of all result rows for a given SQL query.
fetchAssociated ( Model $Model, string $query, array $ids ) : array	Fetch 'hasMany' associations.
fetchResult ( ) : boolean	Fetches the next row from the current result set
fetchRow ( string $sql = null ) : array	Returns a row from current resultset as an array
fetchVirtualField ( &$result ) : void	Modifies $result array to place virtual fields in model entry where they belongs to
field ( string $name, string $sql ) : mixed	Returns a single field of the first of query results for a given SQL query, or false if empty.
fields ( Model $Model, string $alias = null, mixed $fields = [], boolean $quote = true ) : array	Generates the fields list of an SQL query.
flushMethodCache ( ) : void	Empties the method caches.
fullTableName ( Model | string $model, boolean $quote = true, boolean $schema = true ) : string	Gets full table name including prefix
generateAssociationQuery ( Model $Model, Model | null $LinkModel, string $type, string $association, array $assocData, &$queryData, boolean $external ) : mixed	Generates a query or part of a query from a single model or two associated models.
getConnection ( ) : PDO	Get the underlying connection object.
getConstraint ( string $type, Model $Model, Model $LinkModel, string $association, array $assocData, string $association2 = null ) : array	Returns a conditions array for the constraint between two models.
getLog ( boolean $sorted = false, boolean $clear = true ) : array	Get the query log as an array.
getQueryCache ( string $sql, array $params = [] ) : mixed	Returns the result for a sql query if it is already cached
getVersion ( ) : string	Gets the version string of the database server
group ( string | array $fields, Model $Model = null ) : string	Create a GROUP BY SQL clause.
hasAny ( Model $Model, string $sql ) : boolean	Checks if the specified table contains any record matching specified SQL
hasResult ( ) : boolean	Checks if the result is valid
identifier ( string $identifier ) : stdClass	Returns an object to represent a database identifier in a query. Expression objects are not sanitized or escaped.
index ( string $model ) : array	Returns an array of the indexes in given datasource name.
insertMulti ( string $table, array $fields, array $values ) : boolean	Inserts multiple values into a table
introspectType ( string $value ) : string	Guesses the data type of an array
isConnected ( ) : boolean	Checks if the source is connected to the database.
lastAffected ( mixed $source = null ) : integer	Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.
lastError ( PDOStatement $query = null ) : string	Returns a formatted error message from previous database operation.
lastInsertId ( mixed $source = null ) : mixed	Returns the ID generated from the previous INSERT operation.
lastNumRows ( mixed $source = null ) : integer	Returns number of rows in previous resultset. If no previous resultset exists, this returns false.
length ( string $real ) : mixed	Gets the length of a database-native column description, or null if no length
limit ( integer $limit, integer $offset = null ) : string	Returns a limit statement in the correct format for the particular database.
loadCsv ( array $options ) : boolean	CSVファイルをDBに読み込む
loadCsvToArray ( string $path, $encoding ) : mixed	CSVよりデータを配列として読み込む
loadSchema ( array $options ) : boolean	スキーマファイルを利用してテーブルを生成する
logQuery ( string $sql, array $params = [] ) : void	Log given SQL query.
name ( mixed $data ) : string	Returns a quoted name of $data for use in an SQL statement.
nestedTransactionSupported ( ) : boolean	Check if the server support nested transactions
order ( array | string $keys, string $direction = 'ASC', Model $Model = null ) : string	Returns an ORDER BY clause as a string.
prepareFields ( Model $Model, array $queryData ) : array	Prepares fields required by an SQL statement.
query ( ) : resource	DataSource Query abstraction
queryAssociation ( Model $Model, Model $LinkModel, string $type, string $association, array $assocData, &$queryData, boolean $external, &$resultSet, integer $recursive, array $stack ) : mixed	Queries associations.
rawQuery ( string $sql, array $params = [] ) : boolean	Executes given SQL statement.
read ( Model $Model, array $queryData = [], integer $recursive = null ) : mixed	The "R" in CRUD
readSchema ( string $table, $options = [] ) : array	データベースよりスキーマ情報を読み込む
readTableParameters ( string $name ) : array	Read additional table parameters
reconnect ( array $config = [] ) : boolean	Reconnects to database server with optional new settings
renameColumn ( array $options ) : boolean	カラム名を変更する
renameTable ( array $options ) : boolean	テーブル名をリネームする
renderJoinStatement ( array $data ) : string	Renders a final SQL JOIN statement
renderStatement ( string $type, array $data ) : string	Renders a final SQL statement by putting together the component parts in the correct order
resetSequence ( string $table, string $column ) : boolean | void	Reset a sequence based on the MAX() value of $column. Useful for resetting sequences after using insertMulti().
resolveKey ( Model $Model, string $key, string $assoc = null ) : string	Returns a key formatted like a string Model.fieldname(i.e. Post.title, or Country.name)
rollback ( ) : boolean	Rollback a transaction
showLog ( boolean $sorted = false ) : void	Outputs the contents of the queries log. If in a non-CLI environment the sql_log element will be rendered and output. If in a CLI environment, a plain text log is generated.
truncate ( Model | string $table ) : boolean	Deletes all the records in a table and resets the count of the auto-incrementing primary key, where applicable.
update ( Model $Model, array $fields = [], array $values = null, mixed $conditions = null ) : boolean	Generates and executes an SQL UPDATE statement for given model, fields, and values.
value ( string $data, string $column = null ) : string	Returns a quoted and escaped string of $data for use in an SQL statement.
writeCsv ( array $options ) : boolean	DBのデータをCSVファイルとして書きだす
writeCurrentSchema ( string $filename ) : boolean	現在の接続のスキーマを生成する
writeSchema ( $options ) : mixed	モデル名を指定してスキーマファイルを生成する

Защищенные методы

Метод	Описание
_beginNested ( ) : boolean	Begin a nested transaction
_buildFieldParameters ( string $columnString, array $columnData, string $position ) : string	Build the field parameters, in a position
_commitNested ( ) : boolean	Commit a nested transaction
_constructVirtualFields ( Model $Model, string $alias, array $fields ) : array	Converts model virtual fields into sql expressions to be fetched later
_convertFieldToCsv ( string $value, boolean $dc = true ) : string	CSV用のフィールドデータに変換する
_convertRecordToCsv ( array $record ) : array	CSV用のレコードデータに変換する
_dbEncToPhp ( string $enc ) : string	DB用エンコーディング名称をPHP用エンコーディング名称に変換する
_dropTable ( type $table ) : string	Generate a "drop table" statement for a single table
_execute ( string $sql, array $params = [], array $prepareOptions = [] ) : mixed	Executes given SQL statement.
_fetchHasAndBelongsToMany ( Model $Model, string $query, array $ids, string $association ) : array	Fetch 'hasAndBelongsToMany' associations.
_fetchHasMany ( Model $Model, string $query, array $ids ) : array	Fetch 'hasMany' associations.
_filterResults ( &$resultSet, Model $Model, array $filtered = [] ) : array	Passes association results through afterFind filters of the corresponding model.
_getJoins ( Model $Model ) : array	Returns an array of SQL JOIN conditions from a model's associations.
_matchRecords ( Model $Model, mixed $conditions = null ) : array	Gets a list of record IDs for the given conditions. Used for multi-record updates and deletes in databases that do not support aliases in UPDATE/DELETE queries.
_mergeAssociation ( &$data, &$merge, string $association, string $type, boolean $selfJoin = false ) : void	Merge association of merge into data
_mergeConditions ( mixed $query, mixed $assoc ) : array	Merges a mixed set of string/array conditions.
_mergeHasMany ( &$resultSet, array $assocResultSet, string $association, Model $Model ) : void	Merge the results of 'hasMany' associations.
_parseKey ( string $key, mixed $value, Model $Model = null ) : string	Extracts a Model.field identifier and an SQL condition operator from a string, formats and inserts values, and composes them into an SQL snippet.
_phpEncToDb ( string $enc ) : string	PHP用エンコーディング名称をDB用のエンコーディング名称に変換する
_prepareUpdateFields ( Model $Model, array $fields, boolean $quoteValues = true, boolean $alias = false ) : array	Quotes and prepares fields and values for an SQL UPDATE statement
_quoteFields ( string $conditions ) : string	Quotes Model.fields
_quoteMatchedField ( string $match ) : string	Auxiliary function to quote matches Model.fields from a preg_replace_callback call
_rollbackNested ( ) : boolean	Rollback a nested transaction
_scrubQueryData ( array $data ) : array	Private helper method to remove query metadata in given data array.
_writeQueryCache ( string $sql, mixed $data, array $params = [] ) : void	Writes a new key for the in memory sql query cache

Описание методов

Описание свойств