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

Namespace ICanBoogie\ActiveRecord

Namespaces summary

ICanBoogie\ActiveRecord\Driver

Classes summary

ActiveRecordCacheBase Abstract root class for an active records cache.
BelongsToRelation Representation of the one-to-one relation.
Connection A connection to a database.
ConnectionCollection Connection collection.
ConnectionOptions Connection options.
DateTimePropertySupport Provides support for datetime properties.
HasManyRelation Representation of the one-to-many relation.
Helpers Patchable helpers of the ActiveRecord package.
Model Base class for activerecord models.
ModelCollection Model collection.
Query

The class offers many features to compose model queries. Most query related methods of the ICanBoogie\ActiveRecord\Model class create a ICanBoogie\ActiveRecord\Query object that is returned for further specification, such as filters or limits.

Relation Representation of a relation.
RelationCollection Relation collection of a model.
RelationNotDefined Exception thrown in attempt to obtain a relation that is not defined.
RuntimeActiveRecordCache Cache records during run time.
Schema Representation of a database table schema.
SchemaColumn Representation of a schema column.
Statement A database statement.
Table A representation of a database table.

Interfaces summary

ActiveRecordCache Interface for ActiveRecord cache.
Driver Connection driver interface.
Exception The interface is implemented by ActiveRecord exceptions so that they can be easily recognized.

Traits summary

CreatedAtProperty Implements a created_at property.
DateProperty Implements a date property.
DateTimeProperty Implements a datetime property.
FinishAtProperty Implements a finish_at property.
FinishedAtProperty Implements a finished_at property.
StartAtProperty Implements a start_at property.
StartedAtProperty Implements a started_at property.
UpdatedAtProperty Implements a updated_at property.

Exceptions summary

ActiveRecordClassNotValid Exception thrown when the ActiveRecord class is not valid.
ConnectionAlreadyEstablished Exception thrown in attempt to set the definition of an already established connection.
ConnectionNotDefined Exception thrown in attempt to obtain a connection that is not defined.
ConnectionNotEstablished Exception thrown when a connection cannot be established.
DriverNotDefined Exception thrown when there is no driver defined for a given driver name.
ModelAlreadyInstantiated Exception thrown in attempt to set/unset the definition of an already instantiated model.
ModelNotDefined Exception thrown in attempt to obtain a model that is not defined.
RecordNotFound Exception thrown when one or several records cannot be found.
ScopeNotDefined Exception thrown in attempt to obtain a scope that is not defined.
StatementInvocationFailed Exception thrown when the execution of a statement fails.
StatementNotValid Exception thrown in attempt to execute a statement that is not valid.
UnableToSetFetchMode Exception thrown when the fetch mode of a statement fails to be set.

Functions summary

extract_charset_and_collate Extract the charset and collate from a charset/collate union.
get_model Returns the requested model.
ICanBoogie/ActiveRecord master API documentation generated by ApiGen