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

Class Relation

Representation of a relation.

ICanBoogie\ActiveRecord\Relation uses ICanBoogie\Accessor\AccessorTrait (not available)

Direct known subclasses

ICanBoogie\ActiveRecord\BelongsToRelation, ICanBoogie\ActiveRecord\HasManyRelation

Abstract
Namespace: ICanBoogie\ActiveRecord
Located at ActiveRecord/Relation.php

Methods summary

protected get_parent( void )
protected get_related( void )
protected get_as( void )
protected get_local_key( void )
protected get_foreign_key( void )
public __construct( ICanBoogie\ActiveRecord\Model $parent, ICanBoogie\ActiveRecord\Model|string $related, array $options = [] )

Initialize the ICanBoogie\ActiveRecord\Relation::$parent, ICanBoogie\ActiveRecord\Relation::$related, ICanBoogie\ActiveRecord\Relation::$as, ICanBoogie\ActiveRecord\Relation::$local_key, and ICanBoogie\ActiveRecord\Relation::$foreign_key properties.

Initialize the ICanBoogie\ActiveRecord\Relation::$parent, ICanBoogie\ActiveRecord\Relation::$related, ICanBoogie\ActiveRecord\Relation::$as, ICanBoogie\ActiveRecord\Relation::$local_key, and ICanBoogie\ActiveRecord\Relation::$foreign_key properties.

Parameters

$parent
The parent model of the relation.
$related

The related model of the relation. Can be specified using its instance or its identifier.

$options

the following options are available:

  • as: The name of the magic property to add to the prototype. Default: a plural name resolved from the foreign model's id.
  • 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.
abstract public __invoke( ICanBoogie\ActiveRecord $record ) : ICanBoogie\ActiveRecord\Query

Create a query with the relation.

Create a query with the relation.

Parameters

$record

Returns

ICanBoogie\ActiveRecord\Query
protected alter_prototype( ICanBoogie\Prototype $prototype, string $property )

Add a getter for the relation to the prototype.

Add a getter for the relation to the prototype.

Parameters

$prototype
The active record prototype.
$property
The name of the property.
protected resolve_activerecord_class( ICanBoogie\ActiveRecord\Model $model ) : string

Resolve the active record class name from the specified model.

Resolve the active record class name from the specified model.

Parameters

$model

Returns

string

Throws

LogicException
if the class is ICanBoogie\ActiveRecord.
protected resolve_property_name( ICanBoogie\ActiveRecord\Model|string $related ) : string

Resolve the property name from the related model.

Resolve the property name from the related model.

Parameters

$related
The related model of the relation.

Returns

string
protected resolve_related( void ) : ICanBoogie\ActiveRecord\Model

Resolve the related model.

Resolve the related model.

Returns

ICanBoogie\ActiveRecord\Model

Properties summary

protected $parent : ICanBoogie\ActiveRecord\Model

The parent model of the relation.

The parent model of the relation.


		

		

			
            
        
			
				
				protected  
				

				
$related				

				: ICanBoogie\ActiveRecord\Model
			

			

				
The related model of the relation.

			


			

				
The related model of the relation.


			


			

		

		

			
            
        
			
				
				protected  
				

				
$as				

				: string
			

			

				
The name of the relation.

			


			

				
The name of the relation.


			


			

		

		

			
            
        
			
				
				protected  
				

				
$local_key				

				: string
			

			

				
Local key. Default: The parent model's primary key.

			


			

				
Local key. Default: The parent model's primary key.


			


			

		

		

			
            
        
			
				
				protected  
				

				
$foreign_key				

				: string
			

			

				
Foreign key. Default: The parent model's primary key.

			


			

				
Foreign key. Default: The parent model's primary key.


			


			

		

		




		
Magic properties

		

		

			
            
        
			
				
				public  read-only
				

				
$parent				

				: ICanBoogie\ActiveRecord\Model
			

			

				
The parent model of the relation.

			


			

				

			


		

		

			
            
        
			
				
				public  read-only
				

				
$related				

				: ICanBoogie\ActiveRecord\Model
			

			

				
The related model of the relation.

			


			

				

			


		

		

			
            
        
			
				
				public  read-only
				

				
$as				

				: string
			

			

				
The name of the relation.

			


			

				

			


		

		

			
            
        
			
				
				public  read-only
				

				
$local_key				

				: string
			

			

				
The local key.

			


			

				

			


		

		

			
            
        
			
				
				public  read-only
				

				
$foreign_key				

				: string
			

			

				
The foreign key.

			


			

				

			


		

		







	

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