PHP Class Spot\Adapter\PDO\BaseAbstract

Inheritance: extends Spot\Adapter\AdapterAbstract, implements Spot\Adapter\AdapterInterface
Datei anzeigen Open project: vlucas/spot

Protected Properties

Property Type Description
$_database

Public Methods

Method Description
beginTransaction ( ) Begin transaction
commit ( ) Commit transaction
connection ( ) : object Get database connection
count ( Query $query, array $options = [] ) * Count number of rows in source based on conditions
create ( $datasource, array $data, array $options = [] ) Create new row object with set properties
createDatabase ( $database ) Create a database Will throw errors if user does not have proper permissions
delete ( $datasource, array $data, array $options = [] ) Delete entities matching given conditions
dropDatabase ( $database ) Drop a database table Destructive and dangerous - drops entire table and all data Will throw errors if user does not have proper permissions
dropDatasource ( $datasource ) Drop a database table Destructive and dangerous - drops entire table and all data
escape ( string $string ) Escape/quote direct user input
escapeField ( $field ) Escape/quote direct user input
formatMigrateOptions ( array $options ) Ensure migration options are full and have all keys required
migrate ( String $table, array $fields, array $options = [] ) Migrate table structure changes to database
migrateTableCreate ( String $table, array $formattedFields, array $options = [] ) Execute a CREATE TABLE command
migrateTableUpdate ( String $table, array $formattedFields, array $options = [] ) Execute an ALTER/UPDATE TABLE command
prepare ( $sql ) Prepare an SQL statement
query ( string $sql, array $binds = [] ) Find records with custom SQL query
read ( Query $query, array $options = [] ) Build a select statement in SQL Can be overridden by adapters for custom syntax
rollback ( ) Rollback transaction
statementBinds ( array $conditions = [], $ci = false ) Returns array of binds to pass to query function
statementConditions ( array $conditions = [], $ci ) Builds an SQL string given conditions
statementFields ( array $fields = [] ) Return fields as a string for a query statement
toCollection ( Query $query, $stmt ) Return result set for current query
truncateDatasource ( $datasource ) Truncate a database table Should delete all rows and reset serial/auto_increment keys to 0
update ( $datasource, array $data, array $where = [], array $options = [] ) Update entity

Protected Methods

Method Description
bindValues ( PDOStatement $stmt, array $binds ) Bind array of field/value data to given statement
shouldUpdateMigrateField ( array $formattedField, array $columnInfo ) : boolean Should we update the field

Method Details

beginTransaction() public method

Begin transaction
public beginTransaction ( )

bindValues() protected method

Bind array of field/value data to given statement
protected bindValues ( PDOStatement $stmt, array $binds )
$stmt PDOStatement
$binds array

commit() public method

Commit transaction
public commit ( )

connection() public method

Get database connection
public connection ( ) : object
return object PDO

count() public method

* Count number of rows in source based on conditions
public count ( Query $query, array $options = [] )
$query Spot\Query
$options array

create() public method

Create new row object with set properties
public create ( $datasource, array $data, array $options = [] )
$data array
$options array

createDatabase() public method

Create a database Will throw errors if user does not have proper permissions
public createDatabase ( $database )

delete() public method

Delete entities matching given conditions
public delete ( $datasource, array $data, array $options = [] )
$data array
$options array

dropDatabase() public method

Drop a database table Destructive and dangerous - drops entire table and all data Will throw errors if user does not have proper permissions
public dropDatabase ( $database )

dropDatasource() public method

Drop a database table Destructive and dangerous - drops entire table and all data
public dropDatasource ( $datasource )

escape() public method

Escape/quote direct user input
public escape ( string $string )
$string string

escapeField() public method

Escape/quote direct user input
public escapeField ( $field )

formatMigrateOptions() public method

Ensure migration options are full and have all keys required
public formatMigrateOptions ( array $options )
$options array

migrate() public method

Migrate table structure changes to database
public migrate ( String $table, array $fields, array $options = [] )
$table String Table name
$fields array Fields and their attributes as defined in the mapper
$options array Options that may affect migrations or how tables are setup

migrateTableCreate() public method

Execute a CREATE TABLE command
public migrateTableCreate ( String $table, array $formattedFields, array $options = [] )
$table String Table name
$formattedFields array
$options array Options that may affect migrations or how tables are setup

migrateTableUpdate() public method

Execute an ALTER/UPDATE TABLE command
public migrateTableUpdate ( String $table, array $formattedFields, array $options = [] )
$table String Table name
$formattedFields array
$options array Options that may affect migrations or how tables are setup

prepare() public method

Prepare an SQL statement
public prepare ( $sql )

query() public method

Find records with custom SQL query
public query ( string $sql, array $binds = [] )
$sql string SQL query to execute
$binds array Array of bound parameters to use as values for query

read() public method

Build a select statement in SQL Can be overridden by adapters for custom syntax
public read ( Query $query, array $options = [] )
$query Spot\Query
$options array

rollback() public method

Rollback transaction
public rollback ( )

shouldUpdateMigrateField() protected method

Should we update the field
protected shouldUpdateMigrateField ( array $formattedField, array $columnInfo ) : boolean
$formattedField array The formatted field
$columnInfo array
return boolean

statementBinds() public method

Returns array of binds to pass to query function
public statementBinds ( array $conditions = [], $ci = false )
$conditions array

statementConditions() public method

Builds an SQL string given conditions
public statementConditions ( array $conditions = [], $ci )
$conditions array

statementFields() public method

Return fields as a string for a query statement
public statementFields ( array $fields = [] )
$fields array

toCollection() public method

Return result set for current query
public toCollection ( Query $query, $stmt )
$query Spot\Query

truncateDatasource() public method

Truncate a database table Should delete all rows and reset serial/auto_increment keys to 0
public truncateDatasource ( $datasource )

update() public method

Update entity
public update ( $datasource, array $data, array $where = [], array $options = [] )
$data array
$where array
$options array

Property Details

$_database protected_oe property

protected $_database