ICanBoogie
  • Documentation
  • API Reference
  • ActiveRecord 3.0.x
Namespaces
  • ICanBoogie
    • ActiveRecord
      • ActiveRecordCache
      • Driver
      • Property
      • Validate
        • Reader
        • Validator
        • ValidatorProvider
Classes
  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • HasManyRelation
  • Helpers
  • Model
  • ModelCollection
  • Query
  • Relation
  • RelationCollection
  • RelationNotDefined
  • Schema
  • SchemaColumn
  • Statement
  • Table
Interfaces
  • ActiveRecordCache
  • Driver
  • Exception
Exceptions
  • ActiveRecordClassNotValid
  • ConnectionAlreadyEstablished
  • ConnectionNotDefined
  • ConnectionNotEstablished
  • DriverNotDefined
  • ModelAlreadyInstantiated
  • ModelNotDefined
  • RecordNotFound
  • RecordNotValid
  • ScopeNotDefined
  • StatementInvocationFailed
  • StatementNotValid
  • UnableToSetFetchMode

Interface Driver

Connection driver interface.

Direct known implementers

ICanBoogie\ActiveRecord\Connection, ICanBoogie\ActiveRecord\Driver\BasicDriver

Indirect known implementers

ICanBoogie\ActiveRecord\Driver\MySQLDriver, ICanBoogie\ActiveRecord\Driver\SQLiteDriver

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

Methods summary

public quote_string( string|array $string ) : string|array

Quotes a string, or an array of strings.

Quotes a string, or an array of strings.

Parameters

$string

Returns

string|array
public quote_identifier( string|array $identifier ) : string|array

Quotes an identifier, or an array of identifiers.

Quotes an identifier, or an array of identifiers.

Parameters

$identifier

Returns

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

Casts a value into a database compatible representation.

Casts a value into a database compatible representation.

Parameters

$value
$type
One of SchemaColumn::TYPE_*.

Returns

mixed
public render_column( ICanBoogie\ActiveRecord\SchemaColumn $column ) : string

Renders a column definition.

Renders a column definition.

Parameters

$column

Returns

string
public create_table( string $unprefixed_table_name, ICanBoogie\ActiveRecord\Schema $schema ) : ICanBoogie\ActiveRecord\Driver

Creates a table given a schema.

Creates a table given a schema.

Parameters

$unprefixed_table_name
$schema

Returns

ICanBoogie\ActiveRecord\Driver
$this

Throws

Exception
public create_indexes( string $unprefixed_table_name, ICanBoogie\ActiveRecord\Schema $schema ) : ICanBoogie\ActiveRecord\Driver

Creates indexes given a schema.

Creates indexes given a schema.

Parameters

$unprefixed_table_name
$schema

Returns

ICanBoogie\ActiveRecord\Driver
$this

Throws

Exception
public create_unique_indexes( string $unprefixed_table_name, ICanBoogie\ActiveRecord\Schema $schema ) : ICanBoogie\ActiveRecord\Driver

Creates unique indexes given a schema.

Creates unique indexes given a schema.

Parameters

$unprefixed_table_name
$schema

Returns

ICanBoogie\ActiveRecord\Driver
$this

Throws

Exception
public table_exists( string $unprefixed_name ) : boolean

Checks if a specified table exists in the database.

Checks if a specified table exists in the database.

Parameters

$unprefixed_name
The unprefixed name of the table.

Returns

boolean
true if the table exists, false otherwise.
public optimize( void )

Optimizes the tables of the database.

Optimizes the tables of the database.

ActiveRecord 3.0.x – Check on GitHub – API documentation generated by ApiGen