ICanBoogie
  • Documentation
  • API Reference
  • ActiveRecord 4.0.x
Namespaces
  • ICanBoogie
    • ActiveRecord
      • ActiveRecordCache
      • Driver
      • Property
      • Validate
        • Reader
        • Validator
        • ValidatorProvider
Classes
  • BelongsToRelation
  • Connection
  • ConnectionCollection
  • ConnectionOptions
  • HasManyRelation
  • Model
  • ModelCollection
  • ModelProvider
  • 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

Class ModelCollection

Model collection.

ICanBoogie\ActiveRecord\ModelCollection implements ArrayAccess uses ICanBoogie\Accessor\AccessorTrait (not available)
Namespace: ICanBoogie\ActiveRecord
Located at ActiveRecord/ModelCollection.php

Methods summary

protected get_instances( void )
protected get_definitions( void )
protected get_connections( void )
public __construct( ICanBoogie\ActiveRecord\ConnectionCollection $connections, array $definitions = [] )

Initializes the ICanBoogie\ActiveRecord\ModelCollection::$connections and ICanBoogie\ActiveRecord\ModelCollection::$definitions properties.

Initializes the ICanBoogie\ActiveRecord\ModelCollection::$connections and ICanBoogie\ActiveRecord\ModelCollection::$definitions properties.

Parameters

$connections
$definitions
Model definitions.
public offsetExists( string $id ) : boolean

Checks if a model is defined.

Checks if a model is defined.

Parameters

$id
Model identifier.

Returns

boolean

Implementation of

ArrayAccess::offsetExists()
public offsetSet( string $id, array $definition )

Sets the definition of a model.

Sets the definition of a model.

The Model::ID and Model::NAME are set to the provided id if they are not defined.

Parameters

$id
Model identifier.
$definition
Model definition.

Throws

ICanBoogie\ActiveRecord\ModelAlreadyInstantiated
in attempt to write a model already instantiated.

Implementation of

ArrayAccess::offsetSet()
public offsetGet( string $id ) : ICanBoogie\ActiveRecord\Model

Returns a ICanBoogie\ActiveRecord\Model instance.

Returns a ICanBoogie\ActiveRecord\Model instance.

Parameters

$id
Model identifier.

Returns

ICanBoogie\ActiveRecord\Model

Throws

ICanBoogie\ActiveRecord\ModelNotDefined
when the model is not defined.

Implementation of

ArrayAccess::offsetGet()
public offsetUnset( string $id )

Unset the definition of a model.

Unset the definition of a model.

Parameters

$id
Model identifier.

Throws

ICanBoogie\ActiveRecord\ModelAlreadyInstantiated

in attempt to unset the definition of an already instantiated model.

Implementation of

ArrayAccess::offsetUnset()
protected resolve_model_attributes( array $attributes ) : array

Resolves model attributes.

Resolves model attributes.

The methods replaces Model::CONNECTION and Model::EXTENDING identifier with instances.

Parameters

$attributes

Returns

array
protected instantiate_model( array $attributes ) : ICanBoogie\ActiveRecord\Model

Instantiate a model with the specified attributes.

Instantiate a model with the specified attributes.

Parameters

$attributes

Returns

ICanBoogie\ActiveRecord\Model
public install( void ) : ICanBoogie\ActiveRecord\ModelCollection

Install all the models.

Install all the models.

Returns

ICanBoogie\ActiveRecord\ModelCollection
public uninstall( void ) : ICanBoogie\ActiveRecord\ModelCollection

Uninstall all the models.

Uninstall all the models.

Returns

ICanBoogie\ActiveRecord\ModelCollection
public is_installed( void ) : array

Check if models are installed.

Check if models are installed.

Returns

array

An array of key/value pair where key is a model identifier and value true if the model is installed, false otherwise.

Properties summary

protected $instances : ICanBoogie\ActiveRecord\Model[]

Instantiated models.

Instantiated models.

[]
protected $definitions : array

Models definitions.

Models definitions.

[]
protected $connections : ICanBoogie\ActiveRecord\ConnectionCollection

		

Magic properties

public read-only $connections : ICanBoogie\ActiveRecord\ConnectionCollection
public read-only $definitions : array
public read-only $instances : ICanBoogie\ActiveRecord\Model[]
ActiveRecord 4.0.x – Check on GitHub – API documentation generated by ApiGen