1. class
  2. mako
  3. \
  4. database
  5. \
  6. midgard
  7. \
  8. ORM

ORM

abstract class ORM implements JsonSerializable

ORM.

Constants

PRIMARY_KEY_TYPE_INCREMENTING

Incrementing primary key.
PRIMARY_KEY_TYPE_UUID

UUID primary key.
PRIMARY_KEY_TYPE_CUSTOM

Custom primary key.
PRIMARY_KEY_TYPE_NONE

No primary key.

Properties

protected string $connectionName Connection name to use for the model.
static protected ConnectionManager $connectionManager Connection manager instance.
static protected array $traitHooks ORM query builder hooks.
static protected array $traitCasts Trait casts.
protected string $tableName Table name.
protected string $foreignKeyName Foreign key name.
protected string $primaryKey Primary key.
protected int $primaryKeyType Does this table have an auto increment primary index?
protected bool $isPersisted Has the record been loaded from/saved to a database?
protected array $columns Column values.
protected array $original Original column values.
protected array $including Relations to eager load.
$related Related records.
protected array $cast Columns that should be casted to a specific type.
protected array $assignable Columns that can be set through mass assignment.
protected array $protected Columns and relations that are excluded from the array and json representations of the record.
protected string $dateOutputFormat Date format used when returning array and json representations of the record.

Methods

__construct(array $columns = [], bool $raw = false, bool $whitelist = true, bool $isPersisted = false)

Constructor.

__clone()

Making sure that cloning returns a "fresh copy" of the record.

static 
setConnectionManager(ConnectionManager $connectionManager)

Set the connection manager.

Connection
getConnection()

Returns the connection of the model.

bool
isPersisted()

Has the record been loaded from/saved to a database?

synchronize()

Synchronizes the original values with the modified values.

string
getDateFormat()

Gets the date format from the query builder compiler.

registerHooksAndCasts()

Registers hooks and casts.

array
bindHooks(array $hooks)

Binds the hooks to the current instance of "$this".

array
getHooks(string $event)

Returns hooks for the chosen event.

string
getClassShortName(string|null $className = null)

Returns the short name of a class.

string
getTable()

Returns the table name of the model.

string
getPrimaryKey()

Returns the primary key of the table.

int
getPrimaryKeyType()

Returns the primary key type.

mixed
getPrimaryKeyValue()

Returns the primary key value.

string
getForeignKey()

Returns the foreign key of the table.

string
getClass()

Returns the namespaced class name of the model.

setIncludes(array $includes)

Sets the relations to eager load.

array
getIncludes()

Returns the relations to eager load.

setRelated(string $relation, mixed $related)

Sets eagerly loaded related records.

bool
includes(string $relation)

Returns TRUE if the model has included the relationship and FALSE if not.

$this
include(array|string $includes)

Eager loads relations on the model.

array
getRelated()

Returns the related records array.

mixed
cast(string $name, mixed $value)

Cast value to the appropriate type.

setRawColumnValue(string $name, mixed $value)

Sets a raw column value.

setColumnValue(string $name, mixed $value)

Sets a column value.

mixed
getRawColumnValue(string $name)

Gets a raw column value.

mixed
getColumnValue(string $name)

Returns a column value.

bool
isRelation(string $name)

Returns TRUE if it's probable that $name is a relation and FALSE if not.

mixed
getValue(string $name)

Gets a column value or relation.

array
getRawColumnValues()

Returns the columns array.

setColumValues(array $columns, bool $raw)

Sets column values.

$this
assign(array $columns, bool $raw = false, bool $whitelist = true)

Assigns the column values to the model.

__set(string $name, mixed $value)

Set column value using overloading.

mixed
__get(string $name)

Get column value or relation using overloading.

bool
__isset(string $name)

Checks if a column or relation is set using overloading.

__unset(string $name)

Unset column value or relation using overloading.

Query
builder()

Returns a query builder instance.

static ORM|null
get(mixed $id, array $columns = [])

Returns a record using the value of its primary key.

static ORM
create(array $columns = [], bool $raw = false, bool $whitelist = true)

Creates a new record and returns the model.

HasOne
hasOne(string $model, string|null $foreignKey = null)

Returns a HasOne relation.

HasOnePolymorphic
hasOnePolymorphic(string $model, string $polymorphicType)

Returns a HasOnePolymorphic relation.

HasMany
hasMany(string $model, string|null $foreignKey = null)

Returns a HasMany relation.

HasManyPolymorphic
hasManyPolymorphic(string $model, string $polymorphicType)

Returns a HasManyPolymorphic relation.

ManyToMany
manyToMany(string $model, string|null $foreignKey = null, string|null $junctionTable = null, string|null $junctionKey = null)

Returns a ManyToMany relation.

BelongsTo
belongsTo(string $model, string|null $foreignKey = null)

Returns a BelongsTo relation.

BelongsToPolymorphic
belongsToPolymorphic(string $model, string $polymorphicType)

Returns a BelongsToPolymorphic relation.

bool
isModified()

Has the record been modified?

array
getModified()

Returns the modified column values of the record.

mixed
generatePrimaryKey()

Generates a primary key.

insertRecord(Query $query)

Inserts a new record into the database.

bool
updateRecord(Query $query)

Updates an existing record.

bool
save()

Saves the record to the database.

bool
deleteRecord(Query $query)

Deletes a record from the database.

bool
delete()

Deletes a record from the database.

$this
protect(array|false|string $column)

Excludes the chosen columns and relations from array and json representations of the record.

$this
expose(array|string|true $column)

Exposes the chosen columns and relations in the array and json representations of the record.

array
toArray()

Returns an array representation of the record.

array
jsonSerialize()

Returns data which can be serialized by json_encode().

string
toJson(int $options = 0)

Returns a json representation of the record.

string
__toString()

Returns a json representation of the record.

mixed
__call(string $name, array $arguments)

Forwards method calls to the query builder.

static mixed
__callStatic(string $name, array $arguments)

Forwards static method calls to the query builder.

Details

at line 203
__construct(array $columns = [], bool $raw = false, bool $whitelist = true, bool $isPersisted = false)

Constructor.

Parameters

array $columns Column values
bool $raw Set raw values?
bool $whitelist Remove columns that are not in the whitelist?
bool $isPersisted Does the record come from a database?

at line 220
__clone()

Making sure that cloning returns a "fresh copy" of the record.

at line 237
static setConnectionManager(ConnectionManager $connectionManager)

Set the connection manager.

Parameters

ConnectionManager $connectionManager Connection manager instance

at line 247
Connection getConnection()

Returns the connection of the model.

Return Value

Connection

at line 262
bool isPersisted()

Has the record been loaded from/saved to a database?

Return Value

bool

at line 270
synchronize()

Synchronizes the original values with the modified values.

at line 280
protected string getDateFormat()

Gets the date format from the query builder compiler.

Return Value

string

at line 295
protected registerHooksAndCasts()

Registers hooks and casts.

at line 325
protected array bindHooks(array $hooks)

Binds the hooks to the current instance of "$this".

Parameters

array $hooks Array of hooks

Return Value

array

at line 343
array getHooks(string $event)

Returns hooks for the chosen event.

Parameters

string $event Event name

Return Value

array

at line 354
protected string getClassShortName(string|null $className = null)

Returns the short name of a class.

Parameters

string|null $className Class name

Return Value

string

at line 373
string getTable()

Returns the table name of the model.

Return Value

string

at line 388
string getPrimaryKey()

Returns the primary key of the table.

Return Value

string

at line 398
int getPrimaryKeyType()

Returns the primary key type.

Return Value

int

at line 408
mixed getPrimaryKeyValue()

Returns the primary key value.

Return Value

mixed

at line 418
string getForeignKey()

Returns the foreign key of the table.

Return Value

string

at line 433
string getClass()

Returns the namespaced class name of the model.

Return Value

string

at line 443
setIncludes(array $includes)

Sets the relations to eager load.

Parameters

array $includes Relations to eager load

at line 453
array getIncludes()

Returns the relations to eager load.

Return Value

array

at line 464
setRelated(string $relation, mixed $related)

Sets eagerly loaded related records.

Parameters

string $relation Relation name
mixed $related Related record(s)

at line 475
bool includes(string $relation)

Returns TRUE if the model has included the relationship and FALSE if not.

Parameters

string $relation Relation name

Return Value

bool

at line 486
$this include(array|string $includes)

Eager loads relations on the model.

Parameters

array|string $includes Relation or array of relations to eager load

Return Value

$this

at line 501
array getRelated()

Returns the related records array.

Return Value

array

at line 513
protected mixed cast(string $name, mixed $value)

Cast value to the appropriate type.

Parameters

string $name Column name
mixed $value Column value

Return Value

mixed

at line 543
setRawColumnValue(string $name, mixed $value)

Sets a raw column value.

Parameters

string $name Column name
mixed $value Column value

at line 554
setColumnValue(string $name, mixed $value)

Sets a column value.

Parameters

string $name Column name
mixed $value Column value

at line 574
mixed getRawColumnValue(string $name)

Gets a raw column value.

Parameters

string $name Column name

Return Value

mixed

at line 585
mixed getColumnValue(string $name)

Returns a column value.

Parameters

string $name Column name

Return Value

mixed

at line 601
protected bool isRelation(string $name)

Returns TRUE if it's probable that $name is a relation and FALSE if not.

Parameters

string $name Relation name

Return Value

bool

at line 612
mixed getValue(string $name)

Gets a column value or relation.

Parameters

string $name Column name

Return Value

mixed

at line 643
array getRawColumnValues()

Returns the columns array.

Return Value

array

at line 654
protected setColumValues(array $columns, bool $raw)

Sets column values.

Parameters

array $columns Column values
bool $raw Set raw values?

at line 687
$this assign(array $columns, bool $raw = false, bool $whitelist = true)

Assigns the column values to the model.

Parameters

array $columns Column values
bool $raw Set raw values?
bool $whitelist Remove columns that are not in the whitelist?

Return Value

$this

at line 716
__set(string $name, mixed $value)

Set column value using overloading.

Parameters

string $name Column name
mixed $value Column value

at line 727
mixed __get(string $name)

Get column value or relation using overloading.

Parameters

string $name Column name

Return Value

mixed

at line 738
bool __isset(string $name)

Checks if a column or relation is set using overloading.

Parameters

string $name Column or relation name

Return Value

bool

at line 753
__unset(string $name)

Unset column value or relation using overloading.

Parameters

string $name Column name

at line 763
Query builder()

Returns a query builder instance.

Return Value

Query

at line 775
static ORM|null get(mixed $id, array $columns = [])

Returns a record using the value of its primary key.

Parameters

mixed $id Primary key
array $columns Columns to select

Return Value

ORM|null

at line 788
static ORM create(array $columns = [], bool $raw = false, bool $whitelist = true)

Creates a new record and returns the model.

Parameters

array $columns Column values
bool $raw Set raw values?
bool $whitelist Remove columns that are not in the whitelist?

Return Value

ORM

at line 804
protected HasOne hasOne(string $model, string|null $foreignKey = null)

Returns a HasOne relation.

Parameters

string $model Related model
string|null $foreignKey Foreign key name

Return Value

HasOne

at line 818
protected HasOnePolymorphic hasOnePolymorphic(string $model, string $polymorphicType)

Returns a HasOnePolymorphic relation.

Parameters

string $model Related model
string $polymorphicType Polymorphic type

Return Value

HasOnePolymorphic

at line 832
protected HasMany hasMany(string $model, string|null $foreignKey = null)

Returns a HasMany relation.

Parameters

string $model Related model
string|null $foreignKey Foreign key name

Return Value

HasMany

at line 846
protected HasManyPolymorphic hasManyPolymorphic(string $model, string $polymorphicType)

Returns a HasManyPolymorphic relation.

Parameters

string $model Related model
string $polymorphicType Polymorphic type

Return Value

HasManyPolymorphic

at line 862
protected ManyToMany manyToMany(string $model, string|null $foreignKey = null, string|null $junctionTable = null, string|null $junctionKey = null)

Returns a ManyToMany relation.

Parameters

string $model Related model
string|null $foreignKey Foreign key name
string|null $junctionTable Junction table name
string|null $junctionKey Junction key name

Return Value

ManyToMany

at line 876
protected BelongsTo belongsTo(string $model, string|null $foreignKey = null)

Returns a BelongsTo relation.

Parameters

string $model Related model
string|null $foreignKey Foreign key name

Return Value

BelongsTo

at line 890
protected BelongsToPolymorphic belongsToPolymorphic(string $model, string $polymorphicType)

Returns a BelongsToPolymorphic relation.

Parameters

string $model Related model
string $polymorphicType Polymorphic type

Return Value

BelongsToPolymorphic

at line 902
bool isModified()

Has the record been modified?

Return Value

bool

at line 912
array getModified()

Returns the modified column values of the record.

Return Value

array

at line 932
protected mixed generatePrimaryKey()

Generates a primary key.

Return Value

mixed

at line 942
protected insertRecord(Query $query)

Inserts a new record into the database.

Parameters

Query $query Query builder

at line 970
protected bool updateRecord(Query $query)

Updates an existing record.

Parameters

Query $query Query builder

Return Value

bool

at line 982
bool save()

Saves the record to the database.

Return Value

bool

at line 1017
protected bool deleteRecord(Query $query)

Deletes a record from the database.

Parameters

Query $query Query builder

Return Value

bool

at line 1027
bool delete()

Deletes a record from the database.

Return Value

bool

at line 1053
$this protect(array|false|string $column)

Excludes the chosen columns and relations from array and json representations of the record.

You expose all fields by passing FALSE.

Parameters

array|false|string $column Column or relation to hide from the

Return Value

$this

at line 1067
$this expose(array|string|true $column)

Exposes the chosen columns and relations in the array and json representations of the record.

You can expose all fields by passing TRUE.

Parameters

array|string|true $column Column or relation to hide from the

Return Value

$this

at line 1079
array toArray()

Returns an array representation of the record.

Return Value

array

at line 1126
array jsonSerialize()

Returns data which can be serialized by json_encode().

Return Value

array

at line 1137
string toJson(int $options = 0)

Returns a json representation of the record.

Parameters

int $options JSON encode options

Return Value

string

at line 1147
string __toString()

Returns a json representation of the record.

Return Value

string

at line 1159
mixed __call(string $name, array $arguments)

Forwards method calls to the query builder.

Parameters

string $name Method name
array $arguments Method arguments

Return Value

mixed

at line 1171
static mixed __callStatic(string $name, array $arguments)

Forwards static method calls to the query builder.

Parameters

string $name Method name
array $arguments Method arguments

Return Value

mixed