Class ActiveRecord

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

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

Extended by

ICanBoogie\ActiveRecord

Direct known subclasses

Icybee\Modules\Comments\Comment, Icybee\Modules\Contents\Rendered, Icybee\Modules\Users\User, Icybee\Modules\Nodes\Node, Icybee\Modules\Pages\Content, Icybee\Modules\Registry\Entry, Icybee\Modules\Sites\Site, Icybee\Modules\Taxonomy\Terms\Term, Icybee\Modules\Taxonomy\Vocabulary\Vocabulary, Icybee\Modules\Users\NonceLogin\Ticket, Icybee\Modules\Users\Roles\Role

Indirect known subclasses

Icybee\Modules\Articles\Article, Icybee\Modules\Contents\Content, Icybee\Modules\Files\File, Icybee\Modules\Forms\Form, Icybee\Modules\Images\Image, Icybee\Modules\Members\Member, Icybee\Modules\Pages\Page

Namespace: ICanBoogie
Located at vendor/icanboogie/activerecord/lib/activerecord.php

Methods summary

`public`	# `__construct( string\|ICanBoogie\ActiveRecord\Model $model )` Initializes the $model and `ICanBoogie\ActiveRecord::$model_id` properties. Initializes the $model and `ICanBoogie\ActiveRecord::$model_id` properties. Parameters `$model` `string\|ICanBoogie\ActiveRecord\Model` $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. Throws `InvalidArgumentException` if $model is neither a model identifier nor a `ICanBoogie\ActiveRecord\Model` instance.
`public array`	# `__sleep( )` Removes the $model property. Removes the $model property. Properties whose value are instances of the `ICanBoogie\ActiveRecord` class are removed from the exported properties. Returns `array` Overrides `ICanBoogie\Object::__sleep`
`protected ICanBoogie\ActiveRecord\Model`	# `get_model( )` Returns the model managing the active record. Returns the model managing the active record. This getter is used when the model has been provided as a string during construct. Returns `ICanBoogie\ActiveRecord\Model`
`protected string`	# `get_model_id( )` Returns the identifier of the model managing the active record. Returns the identifier of the model managing the active record. The getter is used to provide read-only access to the property. Returns `string`
`public integer`	# `save( )` Saves the active record using its model. Saves the active record using its model. Returns `integer` Primary key value of the active record.
`protected array`	# `alter_persistent_properties( array $properties, ICanBoogie\ActiveRecord\Model $model )` Unless it's an acceptable value for a column, columns with `null` values are discarted. This way, we don't have to define every properties before saving our active record. Unless it's an acceptable value for a column, columns with `null` values are discarted. This way, we don't have to define every properties before saving our active record. Parameters `$properties` `array` $properties `$model` Returns `array` The altered persistent properties
`public boolean`	# `delete( )` Deletes the active record using its model. Deletes the active record using its model. Returns `boolean` `true` if the record was deleted, `false` otherwise.

Methods inherited from ICanBoogie\Object

from(), resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Properties summary

`protected string`	`$model_id`	# Identifier of the model managing the active record. Identifier of the model managing the active record. Note: Due to a PHP bug (or feature), the visibility of the property MUST NOT be private. https://bugs.php.net/bug.php?id=40412

Magic properties

`public read-only ICanBoogie\ActiveRecord\Model`	`$model`		# The model managing the active record. The model managing the active record.
`public read-only string`	`$model_id`		# The identifier of the model managing the active record. The identifier of the model managing the active record.

Magic properties inherited from ICanBoogie\Object