Class Connection

A connection to a database.

PDO

┗ ICanBoogie\ActiveRecord\Connection implements ICanBoogie\ActiveRecord\Driver uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\ActiveRecord
Located at ActiveRecord/Connection.php

Methods summary


				
				 protected 
				
				

				get_id( void )
				

				: string


				
				 protected 
				
				

				get_table_name_prefix( void )
				

				: string


				
				 protected 
				
				

				get_charset( void )
				

				: string


				
				 protected 
				
				

				get_collate( void )
				

				: string


				
				 protected 
				
				

				get_timezone( void )
				

				: string


				
				 protected 
				
				

				get_driver_name( void )
				

				: string


				
				 protected 
				
				

				lazy_get_driver( void )
				

				: ICanBoogie\ActiveRecord\Driver


				
				 public 
				
				

				__construct( string $dsn, string $username = null, string $password = null, array $options = [] )

Establish a connection to a database.


				
				 public 
				
				

				__invoke( void )
				

				: ICanBoogie\ActiveRecord\Statement

Alias to ICanBoogie\ActiveRecord\Connection::query().


				
				 protected 
				
				

				resolve_driver_name( string $dsn )
				

				: string

Resolve the driver name from the DSN string.


				
				 protected 
				
				

				resolve_driver_class( string $driver_name )
				

				: string

Resolves driver class.


				
				 protected 
				
				

				resolve_driver( string $driver_name )
				

				: ICanBoogie\ActiveRecord\Driver

Resolves a ICanBoogie\ActiveRecord\Driver implementation.


				
				 protected 
				
				

				apply_options( array $options )

Applies options to the instance.


				
				 protected 
				
				

				before_connection( array & $options )

Called before the connection.


				
				 protected 
				
				

				after_connection( void )


				
				 public 
				
				

				prepare( string $statement, array $options = [] )
				

				: ICanBoogie\ActiveRecord\Statement

Overrides the method to resolve the statement before it is prepared, then set its fetch mode and connection.

Parameters

$statement: Query statement.
$options

Returns

ICanBoogie\ActiveRecord\Statement
The prepared statement.

Throws

ICanBoogie\ActiveRecord\StatementNotValid
if the statement cannot be prepared.

Overrides

PDO::prepare


				
				 public 
				
				

				query(  $statement, array $args = [], array $options = [] )
				

				: ICanBoogie\ActiveRecord\Statement

Overrides the method in order to prepare (and resolve) the statement and execute it with the specified arguments and options.


				
				 public 
				
				

				exec(  $statement )

Executes a statement.


				
				 public 
				
				

				resolve_statement( string $statement )
				

				: string

Replaces placeholders with their value.

The following placeholders are supported:

{prefix}: replaced by the $table_name_prefix property.
{charset}: replaced by the $charset property.
{collate}: replaced by the $collate property.

Parameters

$statement

Returns

string
The resolved statement.


				
				 public 
				
				

				begin( void )

Alias for the beginTransaction() method.


				
				 public 
				
				

				quote_string( string|array $string )
				

				: string|array


				
				 public 
				
				

				quote_identifier( string|array $identifier )
				

				: string|array


				
				 public 
				
				

				cast_value( mixed $value, string|null $type = null )
				

				: mixed


				
				 public 
				
				

				render_column( ICanBoogie\ActiveRecord\SchemaColumn $column )
				

				: string


				
				 public 
				
				

				create_table( string $unprefixed_name, ICanBoogie\ActiveRecord\Schema $schema )
				

				: ICanBoogie\ActiveRecord\Connection


				
				 public 
				
				

				create_indexes( string $unprefixed_table_name, ICanBoogie\ActiveRecord\Schema $schema )
				

				: ICanBoogie\ActiveRecord\Connection


				
				 public 
				
				

				create_unique_indexes( string $unprefixed_table_name, ICanBoogie\ActiveRecord\Schema $schema )
				

				: ICanBoogie\ActiveRecord\Connection


				
				 public 
				
				

				table_exists( string $unprefixed_name )
				

				: boolean

Parameters

$unprefixed_name: The unprefixed name of the table.

Returns

boolean
true if the table exists, false otherwise.

Inheritdoc

Codecoverageignore

Implementation of

ICanBoogie\ActiveRecord\Driver::table_exists()


				
				 public 
				
				

				optimize( void )

Methods inherited from PDO

__sleep(), __wakeup(), beginTransaction(), commit(), errorCode(), errorInfo(), getAttribute(), getAvailableDrivers(), inTransaction(), lastInsertId(), quote(), rollBack(), setAttribute()

Constants summary

Constants inherited from PDO

ATTR_AUTOCOMMIT, ATTR_CASE, ATTR_CLIENT_VERSION, ATTR_CONNECTION_STATUS, ATTR_CURSOR, ATTR_CURSOR_NAME, ATTR_DEFAULT_FETCH_MODE, ATTR_DRIVER_NAME, ATTR_EMULATE_PREPARES, ATTR_ERRMODE, ATTR_FETCH_CATALOG_NAMES, ATTR_FETCH_TABLE_NAMES, ATTR_MAX_COLUMN_LEN, ATTR_ORACLE_NULLS, ATTR_PERSISTENT, ATTR_PREFETCH, ATTR_SERVER_INFO, ATTR_SERVER_VERSION, ATTR_STATEMENT_CLASS, ATTR_STRINGIFY_FETCHES, ATTR_TIMEOUT, CASE_LOWER, CASE_NATURAL, CASE_UPPER, CURSOR_FWDONLY, CURSOR_SCROLL, ERRMODE_EXCEPTION, ERRMODE_SILENT, ERRMODE_WARNING, ERR_NONE, FETCH_ASSOC, FETCH_BOTH, FETCH_BOUND, FETCH_CLASS, FETCH_CLASSTYPE, FETCH_COLUMN, FETCH_FUNC, FETCH_GROUP, FETCH_INTO, FETCH_KEY_PAIR, FETCH_LAZY, FETCH_NAMED, FETCH_NUM, FETCH_OBJ, FETCH_ORI_ABS, FETCH_ORI_FIRST, FETCH_ORI_LAST, FETCH_ORI_NEXT, FETCH_ORI_PRIOR, FETCH_ORI_REL, FETCH_PROPS_LATE, FETCH_SERIALIZE, FETCH_UNIQUE, MYSQL_ATTR_COMPRESS, MYSQL_ATTR_DIRECT_QUERY, MYSQL_ATTR_FOUND_ROWS, MYSQL_ATTR_IGNORE_SPACE, MYSQL_ATTR_INIT_COMMAND, MYSQL_ATTR_LOCAL_INFILE, MYSQL_ATTR_MULTI_STATEMENTS, MYSQL_ATTR_SERVER_PUBLIC_KEY, MYSQL_ATTR_SSL_CA, MYSQL_ATTR_SSL_CAPATH, MYSQL_ATTR_SSL_CERT, MYSQL_ATTR_SSL_CIPHER, MYSQL_ATTR_SSL_KEY, MYSQL_ATTR_USE_BUFFERED_QUERY, NULL_EMPTY_STRING, NULL_NATURAL, NULL_TO_STRING, ODBC_ATTR_ASSUME_UTF8, ODBC_ATTR_USE_CURSOR_LIBRARY, ODBC_SQL_USE_DRIVER, ODBC_SQL_USE_IF_NEEDED, ODBC_SQL_USE_ODBC, PARAM_BOOL, PARAM_EVT_ALLOC, PARAM_EVT_EXEC_POST, PARAM_EVT_EXEC_PRE, PARAM_EVT_FETCH_POST, PARAM_EVT_FETCH_PRE, PARAM_EVT_FREE, PARAM_EVT_NORMALIZE, PARAM_INPUT_OUTPUT, PARAM_INT, PARAM_LOB, PARAM_NULL, PARAM_STMT, PARAM_STR, PGSQL_ATTR_DISABLE_PREPARES, PGSQL_TRANSACTION_ACTIVE, PGSQL_TRANSACTION_IDLE, PGSQL_TRANSACTION_INERROR, PGSQL_TRANSACTION_INTRANS, PGSQL_TRANSACTION_UNKNOWN

Properties summary


				
				public  
				

				
$queries_count				

				: integer

The number of database queries and executions, used for statistics purpose.


				
				public  
				

				
$profiling				

				: array[]

The number of micro seconds spent per request.

[]

Magic properties


				
				public  read-only
				

				
$charset				

				: string

The character set used to communicate with the database. Defaults to "utf8".


				
				public  read-only
				

				
$collate				

				: string

The collation of the character set. Defaults to "utf8_general_ci".


				
				public  read-only
				

				
$driver				

				: ICanBoogie\ActiveRecord\Driver


				
				public  read-only
				

				
$driver_name				

				: string

Name of the PDO driver.


				
				public  read-only
				

				
$id				

				: string

Identifier of the database connection.


				
				public  read-only
				

				
$table_name_prefix				

				: string

The prefix to prepend to every table name.

Class Connection

Methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Link

Overrides

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Throws

Overrides

Returns

Inheritdoc

Overrides

Throws

Inheritdoc

Overrides

Parameters

Returns

See

Parameters

Returns

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Throws

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Throws

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Throws

Inheritdoc

Codecoverageignore

Implementation of

Parameters

Returns

Inheritdoc

Codecoverageignore

Implementation of

Inheritdoc

Codecoverageignore