Class ActiveRecord

Active Record facilitates the creation and use of business objects whose data require persistent storage via database.

ICanBoogie\Prototyped

┗ ICanBoogie\ActiveRecord

Namespace: ICanBoogie
Located at ActiveRecord.php

Methods summary


				
				 public 
				
				

				__construct( string|ICanBoogie\ActiveRecord\Model|null $model = null )

Initializes the $model and ICanBoogie\ActiveRecord::$model_id properties.

Parameters

$model: The model managing the active record. A ICanBoogie\ActiveRecord\Model instance can be specified as well as a model identifier. If a model identifier is specified, the model is resolved when the $model property is accessed. If $model is empty, the identifier of the model is read from the ICanBoogie\ActiveRecord::MODEL_ID class constant.

Throws

InvalidArgumentException

if $model is neither a model identifier nor a ICanBoogie\ActiveRecord\Model instance.


				
				 public 
				
				

				__sleep( void )

Removes the $model property.


				
				 public 
				
				

				__debugInfo( void )
				

				: array

Removes model from the output, since model_id is good enough to figure which model is used.


				
				 protected 
				
				

				get_model( void )
				

				: ICanBoogie\ActiveRecord\Model

Returns the model managing the active record.


				
				 protected 
				
				

				get_model_id( void )
				

				: string

Returns the identifier of the model managing the active record.


				
				 protected 
				
				

				get_is_new( void )
				

				: boolean

Whether the record is new or not.


				
				 public 
				
				

				save( array $options = [] )
				

				: boolean|integer

Saves the active record using its model.


				
				 public 
				
				

				assert_is_valid( void )
				

				: ICanBoogie\ActiveRecord

Assert that a record is valid.


				
				 public 
				
				

				create_validation_rules( void )
				

				: array

Creates validation rules.


				
				 protected 
				
				

				alter_persistent_properties( array $properties, ICanBoogie\ActiveRecord\Schema $schema )
				

				: array

Unless it's an acceptable value for a column, columns with null values are discarded. This way, we don't have to define every properties before saving our active record.

Parameters

$properties
$schema: The model's extended schema.

Returns

array
The altered persistent properties


				
				 protected 
				
				

				update_primary_key( array|string|integer $primary_key )

Updates primary key.


				
				 public 
				
				

				delete( void )
				

				: boolean

Deletes the active record using its model.

Magic methods summary


				
				 public 
				
				

				validate( void )
				

				: ICanBoogie\Validate\ValidationErrors

Validate the active record, returns an array of errors.

Constants summary


				
SAVE_SKIP_VALIDATION				

                : string

'skip_validation'


				
MODEL_ID				

                : string

The identifier of the model managing the record.

null

Properties summary


				
				protected  
				

				
$model_id				

				: string

Identifier of the model managing the active record.

Magic properties


				
				public  read-only
				

				
$model				

				: ICanBoogie\ActiveRecord\Model

The model managing the active record.


				
				public  read-only
				

				
$model_id				

				: string

The identifier of the model managing the active record.


				
				public  read-only
				

				
$is_new				

				: boolean

Whether the record is new or not.