Class RelationCollection

Relation collection of a model.

ICanBoogie\ActiveRecord\RelationCollection implements ArrayAccess uses ICanBoogie\Accessor\AccessorTrait (not available)

Namespace: ICanBoogie\ActiveRecord
Located at RelationCollection.php

Methods summary


				
				 protected 
				
				

				get_model( void )


				
				 public 
				
				

				__construct( ICanBoogie\ActiveRecord\Model $model )

Initialize the ICanBoogie\ActiveRecord\RelationCollection::$model property.


				
				 public 
				
				

				offsetExists(  $relation_name )


				
				 public 
				
				

				offsetGet(  $relation_name )


				
				 public 
				
				

				offsetSet(  $relation_name,  $relation )


				
				 public 
				
				

				offsetUnset(  $relation_name )


				
				 public 
				
				

				belongs_to( string|array $belongs_to )
				

				: ICanBoogie\ActiveRecord\Model

Add a belongs to relation.

$cars->belongs_to([ $drivers, $brands ]);
# or
$cars->belongs_to([ 'drivers', 'brands' ]);
# or
$cars->belongs_to($drivers, $brands);
# or
$cars->belongs_to($drivers)->belongs_to($brands);
# or
$cars->belongs_to([

    [ $drivers, [ 'local_key' => 'card_id', 'foreign_key' => 'driver_id' ] ]
    [ $brands, [ 'local_key' => 'brand_id', 'foreign_key' => 'brand_id' ] ]

]);

Parameters

$belongs_to

Returns

ICanBoogie\ActiveRecord\Model


				
				 public 
				
				

				has_many( ICanBoogie\ActiveRecord\Model|string $related, array $options = [] )
				

				: ICanBoogie\ActiveRecord\Model

Add a one-to-many relation.

$this->has_many('comments');
$this->has_many([ 'comments', 'attachments' ]);
$this->has_many([ [ 'comments', [ 'as' => 'comments' ] ], 'attachments' ]);

Parameters

$related

The related model can be specified using its instance or its identifier.

$options

the following options are available:

local_key: The name of the local key. Default: The parent model's primary key.
foreign_key: The name of the foreign key. Default: The parent model's primary key.
as: The name of the magic property to add to the prototype. Default: a plural name resolved from the foreign model's id.

Returns

ICanBoogie\ActiveRecord\Model

See

ICanBoogie\ActiveRecord\HasManyRelation

Properties summary


				
				protected  
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

Parent model.


				
				protected  
				

				
$relations				

				: ICanBoogie\ActiveRecord\Relation[]

Relations.

Magic properties


				
				public  read-only
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

The parent model.

Class RelationCollection

Methods summary

Parameters

Implementation of

Implementation of

Implementation of

Implementation of

Parameters

Returns

Parameters

Returns

See

Properties summary

Magic properties