ICanBoogie/ActiveRecord master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • ActiveRecord
      • Driver

Classes

  • ActiveRecordCacheBase
  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • DateTimePropertySupport
  • HasManyRelation
  • Helpers
  • Model
  • ModelCollection
  • Query
  • Relation
  • RelationCollection
  • RelationNotDefined
  • RuntimeActiveRecordCache
  • Schema
  • SchemaColumn
  • Statement
  • Table

Interfaces

  • ActiveRecordCache
  • Driver
  • Exception

Traits

  • CreatedAtProperty
  • DateProperty
  • DateTimeProperty
  • FinishAtProperty
  • FinishedAtProperty
  • StartAtProperty
  • StartedAtProperty
  • UpdatedAtProperty

Exceptions

  • ActiveRecordClassNotValid
  • ConnectionAlreadyEstablished
  • ConnectionNotDefined
  • ConnectionNotEstablished
  • DriverNotDefined
  • ModelAlreadyInstantiated
  • ModelNotDefined
  • RecordNotFound
  • ScopeNotDefined
  • StatementInvocationFailed
  • StatementNotValid
  • UnableToSetFetchMode

Functions

  • extract_charset_and_collate
  • get_model

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 string|array
# quote_string( string|array $string )

Quotes a string, or an array of strings.

Quotes a string, or an array of strings.

Parameters

$string

Returns

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

Quotes an identifier, or an array of identifiers.

Quotes an identifier, or an array of identifiers.

Parameters

$identifier

Returns

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

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 string
# render_column( ICanBoogie\ActiveRecord\SchemaColumn $column )

Renders a column definition.

Renders a column definition.

Parameters

$column

Returns

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

Creates a table given a schema.

Creates a table given a schema.

Parameters

$unprefixed_table_name
$schema

Returns


$this

Throws

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

Creates indexes given a schema.

Creates indexes given a schema.

Parameters

$unprefixed_table_name
$schema

Returns


$this

Throws

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

Creates unique indexes given a schema.

Creates unique indexes given a schema.

Parameters

$unprefixed_table_name
$schema

Returns


$this

Throws

Exception
public boolean
# table_exists( string $unprefixed_name )

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( )

Optimizes the tables of the database.

Optimizes the tables of the database.

ICanBoogie/ActiveRecord master API documentation generated by ApiGen