Model
abstract class Model implements ArrayAccess, JsonSerializable (View source)
Traits
Properties
| static protected Builder | $builder | The query builder instance |
|
| $hidden | The hidden field |
||
| protected bool | $timestamps | Enable the timestamps support |
|
| protected string | $prefix | Define the table prefix |
|
| protected bool | $auto_increment | Enable the autoincrement support |
|
| protected bool | $soft_delete | Enable the soft deletion |
|
| protected string | $latest | Defines the column where the query construct will use for the last query |
|
| protected string | $created_at | Defines the created_at column name |
|
| protected string | $updated_at | Defines the created_at column name |
|
| protected array | $attributes | The table columns listing |
|
| protected array | $dates | The date mutation |
|
| protected array | $casts | The casts mutation |
|
| protected string | $primary_key | The table primary key column name |
|
| protected string | $primary_key_type | The table primary key type |
|
| protected string | $table | The table name |
|
| protected ?string | $connection | The connection name |
Methods
The has one relative
Retrieves the primary key
The belongs to many relative
The has many relative
The has one relative
Model constructor.
Get the table name.
No description
Set the connection
Set connection point
Get all records
Get latest
Get first rows
retrieve by column name
retrieve information and delete it
retrieve
Delete a record
Retrieves the primary key value
retrieve information by id or throws an exception in data box not found
persist aliases on insert action
Delete a record
Pagination configuration
Allows to associate listener
Allows to associate listener
Allows to associate a listener
Allows to associate a listener
Allows to associate a listener
Allows to associate a listener
Delete Active Record by column name
__callStatic
Retrieves the primary key
Used to update the timestamp.
Assign a value
Retrieves the list of attributes.
Assign values to class attributes
Allows you to recover an attribute
Returns the data
No description
__get
__set
__toString
Returns the data
__call
No description
No description
No description
No description
No description
Details
BelongsTo
belongsTo(string $related, string|null $foreign_key = null, string|null $local_key = null)
The has one relative
string
getKey()
Retrieves the primary key
BelongsToMany
belongsToMany(string $related, string|null $primary_key = null, string|null $foreign_key = null)
The belongs to many relative
HasMany
hasMany(string $related, string|null $primary_key = null, string|null $foreign_key = null)
The has many relative
HasOne
hasOne(string $related, string|null $foreign_key = null, string|null $primary_key = null)
The has one relative
void
offsetSet(mixed $offset, mixed $value)
_offsetSet
bool
offsetExists(mixed $offset)
_offsetExists
void
offsetUnset(mixed $offset)
_offsetUnset
mixed
offsetGet(mixed $offset)
_offsetGet
array
__serialize()
Serialize model
void
__unserialize(array $attributes)
Unserialize
__construct(array $attributes = [])
Model constructor.
string
getTable()
Get the table name.
string|null
getConnection()
No description
static Builder
query()
Initialize the connection
static Model
connection(string $name)
Set the connection
Builder
setConnection(string $name)
Set connection point
static Collection
all(array $columns = [])
Get all records
static Model|null
latest()
Get latest
static array|object|null
first()
Get first rows
static Collection
retrieveBy(string $column, mixed $value)
retrieve by column name
static Model|null
retrieveAndDelete(int|string|array $id, array $select = ['*'])
retrieve information and delete it
static array|object|null
retrieve(int|string|array $id, array $select = ['*'])
retrieve
int
delete()
Delete a record
mixed
getKeyValue()
Retrieves the primary key value
static array|object
retrieveOrFail(int|string $id, array $select = ['*'])
retrieve information by id or throws an exception in data box not found
static Model
create(array $data)
Create a persist information
int
persist()
persist aliases on insert action
int|bool
update(array $attributes)
Delete a record
static Pagination
paginate(int $page_number, int $current = 0, int|null $chunk = null)
Pagination configuration
static void
deleted(callable $cb)
Allows to associate listener
static void
deleting(callable $cb)
Allows to associate listener
static void
creating(callable $cb)
Allows to associate a listener
static void
created(callable $cb)
Allows to associate a listener
static void
updating(callable $cb)
Allows to associate a listener
static void
updated(callable $cb)
Allows to associate a listener
static int
deleteBy(string $column, mixed $value)
Delete Active Record by column name
static mixed
__callStatic(string $name, array $arguments)
__callStatic
string
getKeyType()
Retrieves the primary key
bool
touch()
Used to update the timestamp.
void
setAttribute(string $key, string $value)
Assign a value
array
getAttributes()
Retrieves the list of attributes.
void
setAttributes(array $attributes)
Assign values to class attributes
mixed
getAttribute(string $key)
Allows you to recover an attribute
array
toArray()
Returns the data
array
jsonSerialize()
No description
mixed
__get(string $name)
__get
__set(string $name, mixed $value)
__set
string
__toString()
__toString
string
toJson()
Returns the data
mixed
__call(string $name, array $arguments = [])
__call
void
select(array|string[] $select)
No description
void
whereIn(string $primary_key, array $id)
No description
void
get()
No description
void
where(string $column, mixed $value)
No description
void
orderBy(string $latest, string $string)
No description