Methods

getTable()

getTable() : string

Returns table name mapped in the model

Returns

string

getDb()

getDb() : string

Gets internal database connection

Returns

string

getAnyShard()

getAnyShard() : array

Returns

array

getUniqueShard()

getUniqueShard(array|\ManaPHP\Data\Model  $context) : array

Parameters

array|\ManaPHP\Data\Model $context

Returns

array

getMultipleShards()

getMultipleShards(array|\ManaPHP\Data\Model  $context) : array

Parameters

array|\ManaPHP\Data\Model $context

Returns

array

getAllShards()

getAllShards() : array

Returns

array

getPrimaryKey()

getPrimaryKey() : string

Returns

string

getForeignedKey()

getForeignedKey() : string

Returns

string

getFields()

getFields() : array

Returns

array

hasField()

hasField(string  $field) : boolean

Parameters

string $field

Returns

boolean

getDateFormat()

getDateFormat(string  $field) : string

Parameters

string $field

Returns

string

getSafeFields()

getSafeFields() : array

Returns

array

getJsonFields()

getJsonFields() : array

Returns

array

getIntFields()

getIntFields() : array|null

Returns

array|null

getAutoIncrementField()

getAutoIncrementField() : string|null

Returns

string|null

getNextAutoIncrementId()

getNextAutoIncrementId(integer  $step = 1) : integer

Parameters

integer $step

Returns

integer

rules()

rules() : array

Returns

array

labels()

labels() : array

Returns

array

sample()

sample() : static

Returns

static

query()

query(string  $alias = null) : \ManaPHP\Data\Db\Query

Parameters

string $alias

Returns

\ManaPHP\Data\Db\Query

all()

all(array  $filters = array(), array  $options = null, array  $fields = null) : array<mixed,static>

Allows to query a set of records that match the specified conditions

Parameters

array $filters
array $options
array $fields

Returns

array<mixed,static>

paginate()

paginate(array  $filters = array(), array  $options = null, array  $fields = null) : \ManaPHP\Data\Paginator

Allows to query a set of records that match the specified conditions

Parameters

array $filters
array $options
array $fields

Returns

\ManaPHP\Data\Paginator

lists()

lists(string|array  $fields, array  $filters = null) : array

Parameters

string|array $fields
array $filters

Returns

array

get()

get(integer|string  $id, integer|array  $fieldsOrTtl = null) : static

Parameters

integer|string $id
integer|array $fieldsOrTtl

Returns

static

first()

first(integer|string|array  $filters, array  $fields = null) : static|null

Allows to query the first record that match the specified conditions

Parameters

integer|string|array $filters
array $fields

Returns

static|null

firstOrFail()

firstOrFail(integer|string|array  $filters, array  $fields = null) : static

Parameters

integer|string|array $filters
array $fields

Returns

static

rId()

rId() : integer|string

Returns

integer|string

rGet()

rGet(array  $fields = null) : static

Parameters

array $fields

Returns

static

last()

last(array  $filters = null, array  $fields = null) : static|null

Allows to query the last record that match the specified conditions

Parameters

array $filters
array $fields

Returns

static|null

value()

value(integer|string|array  $filters, string  $field, integer  $ttl = null) : integer|float|string|null

Parameters

integer|string|array $filters
string $field
integer $ttl

Returns

integer|float|string|null

valueOrFail()

valueOrFail(integer|string|array  $filters, string  $field, integer  $ttl = null) : integer|float|string

Parameters

integer|string|array $filters
string $field
integer $ttl

Returns

integer|float|string

valueOrDefault()

valueOrDefault(integer|string|array  $filters, string|float|integer  $field, mixed  $default) : float|integer|string

Parameters

integer|string|array $filters
string|float|integer $field
mixed $default

Returns

float|integer|string

values()

values(string  $field, array  $filters = null) : array

Parameters

string $field
array $filters

Returns

array

exists()

exists(string|array  $filters) : boolean

Parameters

string|array $filters

Returns

boolean

aggregate()

aggregate(array  $filters, array  $aggregation, string|array  $options = null) : array

Parameters

array $filters
array $aggregation
string|array $options

Returns

array

count()

count(array  $filters = null, string  $field = '*') : integer

Allows to count how many records match the specified conditions

Parameters

array $filters
string $field

Returns

integer

sum()

sum(string  $field, array  $filters = null) : integer|float|null

Allows to calculate a summary on a column that match the specified conditions

Parameters

string $field
array $filters

Returns

integer|float|null

max()

max(string  $field, array  $filters = null) : integer|float|null

Allows to get the max value of a column that match the specified conditions

Parameters

string $field
array $filters

Returns

integer|float|null

min()

min(string  $field, array  $filters = null) : integer|float|null

Allows to get the min value of a column that match the specified conditions

Parameters

string $field
array $filters

Returns

integer|float|null

avg()

avg(string  $field, array  $filters = null) : float|null

Allows to calculate the average value on a column matching the specified conditions

Parameters

string $field
array $filters

Returns

float|null

load()

load(array  $fields = null) : static

Parameters

array $fields

Returns

static

assign()

assign(array|\ManaPHP\Data\Model  $data, array  $fields) : static

Assigns values to a model from an array

Parameters

array|\ManaPHP\Data\Model $data
array $fields

Returns

static

validate()

validate(array  $fields = null) : void

Parameters

array $fields

validateField()

validateField(string  $field, array  $rules = null) : void

Parameters

string $field
array $rules

save()

save(array  $fields = null) : static

Inserts or updates a model instance. Returning true on success or false otherwise.

Parameters

array $fields

Returns

static

create()

create() : static

Inserts a model instance. If the instance already exists in the persistence it will throw an exception Returning true on success or false otherwise.

Returns

static

rCreate()

rCreate(array  $fields = null) : static

Parameters

array $fields

Returns

static

update()

update() : static

Updates a model instance. If the instance does n't exist in the persistence it will throw an exception Returning true on success or false otherwise.

Returns

static

rUpdate()

rUpdate(array  $fields = null) : static

Parameters

array $fields

Returns

static

updateAll()

updateAll(array  $fieldValues, array  $filters) : integer

Parameters

array $fieldValues
array $filters

Returns

integer

delete()

delete() : static

Deletes a model instance. Returning true on success or false otherwise.

Returns

static

rDelete()

rDelete() : static|null

Returns

static|null

deleteAll()

deleteAll(array  $filters) : integer

Parameters

array $filters

Returns

integer

insert()

insert(array  $record) : integer

Parameters

array $record

Returns

integer

with()

with(string|array  $withs) : static

Parameters

string|array $withs

Returns

static

toArray()

toArray() : array

Returns the instance as an array representation

Returns

array

only()

only(array  $fields) : static

Parameters

array $fields

Returns

static

except()

except(array  $fields) : static

Parameters

array $fields

Returns

static

getSnapshotData()

getSnapshotData() : array

Returns the internal snapshot data

Returns

array

getChangedFields()

getChangedFields() : array

Returns a list of changed values

Returns

array

hasChanged()

hasChanged(string|array  $fields) : boolean

Check if a specific attribute has changed This only works if the model is keeping data snapshots

Parameters

string|array $fields

Returns

boolean

refresh()

refresh(float  $interval, array  $fields = null) : static

Parameters

float $interval
array $fields

Returns

static

constants()

constants(string  $name, boolean  $comment = false) : array

Parameters

string $name
boolean $comment

Throws

\ReflectionException

Returns

array

increment()

increment(string  $field, integer|float  $step = 1) : static

Parameters

string $field
integer|float $step

Returns

static

decrement()

decrement(string  $field, integer|float  $step = 1) : static

Parameters

string $field
integer|float $step

Returns

static

select()

select(array|string  $fields = array(), string  $alias = null) : \ManaPHP\Data\QueryInterface

Parameters

array|string $fields
string $alias

Returns

\ManaPHP\Data\QueryInterface

where()

where(integer|string|array  $filters) : \ManaPHP\Data\QueryInterface

Parameters

integer|string|array $filters

Returns

\ManaPHP\Data\QueryInterface

belongsTo()

belongsTo(string  $thatModel, string  $thisField = null) : \ManaPHP\Data\Relation\BelongsTo

Parameters

string $thatModel
string $thisField

Returns

\ManaPHP\Data\Relation\BelongsTo

hasOne()

hasOne(string  $thatModel, string  $thatField = null) : \ManaPHP\Data\Relation\HasOne

Parameters

string $thatModel
string $thatField

Returns

\ManaPHP\Data\Relation\HasOne

hasMany()

hasMany(string  $thatModel, string  $thatField = null) : \ManaPHP\Data\Relation\HasMany

Parameters

string $thatModel
string $thatField

Returns

\ManaPHP\Data\Relation\HasMany

hasManyToMany()

hasManyToMany(string  $thatModel, string  $pivotModel) : \ManaPHP\Data\Relation\HasManyToMany

Parameters

string $thatModel
string $pivotModel

Returns

\ManaPHP\Data\Relation\HasManyToMany

hasManyOthers()

hasManyOthers(string  $thatModel, string  $thisFilter = null) : \ManaPHP\Data\Relation\HasManyOthers

Parameters

string $thatModel
string $thisFilter

=key(get_object_vars(new static))

Returns

\ManaPHP\Data\Relation\HasManyOthers

belongsToMany()

belongsToMany(string  $thatModel, string  $pivotModel) : \ManaPHP\Data\Relation\HasManyToMany

alias of hasManyToMany

Parameters

string $thatModel
string $pivotModel

Returns

\ManaPHP\Data\Relation\HasManyToMany

insertBySql()

insertBySql(array|string  $sql) : integer

Parameters

array|string $sql

Returns

integer

deleteBySql()

deleteBySql(array|string  $sql) : integer

Parameters

array|string $sql

Returns

integer

updateBySql()

updateBySql(string|array  $sql) : integer

Parameters

string|array $sql

Returns

integer