1. class
  2. Netflex
  3. \
  4. Query
  5. \
  6. QueryableModel

QueryableModel

abstract class QueryableModel implements Arrayable, ArrayAccess, Jsonable, JsonSerializable, UrlRoutable

Traits

GuardsAttributes
HasAttributes
HasEvents
HasRelation
HasTimestamps
HidesAttributes
ModelMapper
Queryable
Resolvable
Macroable

Constants

CREATED_AT

The name of the "created at" column.
UPDATED_AT

The name of the "updated at" column.

Properties

protected string $defaultOrderByField Determines the default field to order the query by from  Queryable
protected string $defaultSortDirection Determines the default direction to order the query by from  Queryable
protected string|null $connection The connection name for the model.
protected int $perPage The number of models to return for pagination.
protected bool $useChunking Determines if QueryableModel::all() calls in queries should chunk the result.
bool $exists Indicates if the model exists.
bool $wasRecentlyCreated Indicates if the model was inserted during the current request lifecycle.
static protected array $traitInitializers The array of trait initializers that will be called on each new instance.
static protected array $booted The array of booted models.
protected array $attributes The interal storage of the model data.
protected string $relation The relation associated with the model.
protected int $relationId The directory_id associated with the model.
protected string $primaryField The primary field for the model.
protected string $keyType The "type" of the primary key ID.
protected string $resolvableField The resolvable field associated with the model.
bool $incrementing Indicates if the IDs are auto-incrementing.
protected bool $respectPublishingStatus Indicates if we should respect the models publishing status when retrieving it.
protected bool $autoPublishes Indicates if we should automatically publish the model on save.
static protected Dispatcher $dispatcher The event dispatcher
protected bool $cachesResults Determines if we should cache some results.

Methods

string
getRelation()

Gets the relation

from  HasRelation
int|null
getRelationId()

Gets the relation_id

from  HasRelation
string
getCacheIdentifier(mixed $identifier = null)

Creates a cacheKey

from  HasRelation
getAllCacheIdentifier()

No description

from  HasRelation
Closure
getMapper()

No description

from  ModelMapper
static Builder
makeQueryBuilder($appends = [])

No description

from  Queryable
bool
respectPublishingStatus()

Determine if this object respects publishing statuses when performing queries

from  Queryable
static Builder
disregardingPublishingStatus(bool $disregarding = true)

Override the publishing status for the model

from  Queryable
static Builder
field(...$args)

Adds a field that should be retrieved

from  Queryable
static Builder
fields(...$args)

Sets which fields to retrieve (default: All fields)

from  Queryable
static Builder
limit(...$args)

Limits the results to $limit amount of hits

from  Queryable
static Builder
orderBy(...$args)

Sets the field which to order the results by

from  Queryable
static Builder
raw(...$args)

Performs a raw query, use carefully.

from  Queryable
static Builder
publishedAt(...$args)

Performs a 'publishedAt' query

from  Queryable
static Builder
where(...$args)

Performs a 'where' query

from  Queryable
static Builder
whereIn(...$args)

Queries where field exists in the values

from  Queryable
static Builder
whereNot(...$args)

Performs a 'whereNot' query

from  Queryable
static 
whereBetween(...$args)

No description

from  Queryable
static 
whereNotBetween(...$args)

No description

from  Queryable
static Paginator
paginate(...$args)

Creates a paginated result

from  Queryable
static mixed
maybeMutatesCache(string $key, bool $shouldCache, Closure $action)

Perform an action and mutate the given key if $shouldCache is true

from  Queryable
static Builder
maybeCacheResults(string $key, bool $shouldCache)

Cache the results with the given key if $shouldCache is true

from  Queryable
static Builder
cacheResults(string $key)

Cache the results with the given key

from  Queryable
static int
count(...$args)

Get the count of items matching the current query

from  Queryable
static Queryable|Collection
random(int $amount = 1)

Picks random items

from  Queryable
static Builder
query(string $query = '*')

No description

from  Queryable
getPrimaryField()

No description

from  Resolvable
getResolvableField()

No description

from  Resolvable
static mixed
resolvableContext(Closure $context)

Exectures the context if object can be resolved

from  Resolvable
static Resolvable|null
first()

Retrieves the first instance

from  Resolvable
static Resolvable
firstOrFail()

Retrieves the first instance or fails

from  Resolvable
static Resolvable|null
last()

Retrieves the latest instance

from  Resolvable
static Collection|LazyCollection
all()

Retrieves all instances

from  Resolvable
static 
chunked($chunkSize = null)

No description

from  Resolvable
static QueryableModel|Collection|null
resolve($rawValue, string|null $field = null)

Resolves an instance

static Resolvable|Collection
resolveOrFail(mixed $resolveBy)

Resolves an instance or throws an exception

from  Resolvable
static Collection
resolveMany(array $resolveBy)

Resolves multiple instances by their primary fields

from  Resolvable
static Resolvable|Collection|null
find(mixed|array|Collection $findBy)

Finds an instance by its primary field

from  Resolvable
static Resolvable|Collection
findOrFail(mixed|array $findBy)

Finds an instance by its primary field or throws an exception

from  Resolvable
static Collection
findMany(array $findBy)

Finds multiple instances by their primary fields

from  Resolvable
__construct(array $attributes = [], bool $boot = true)

No description

APIClient
getConnection()

Get the api connection for the model.

string|null
getConnectionName()

Get the current connection name for the model.

$this
setConnection(string|null $name)

Set the connection associated with the model.

array|null
performRetrieveRequest(int|null $relationId = null, mixed $key)

Retrieves a record by key

mixed
performInsertRequest(int|null $relationId = null, array $attributes = [])

Inserts a new record, and returns its id

void
performUpdateRequest(int|null $relationId = null, mixed $key, array $attributes = [])

Updates a record

bool
performDeleteRequest(int|null $relationId = null, mixed $key)

Deletes a record

QueryableModel|null
fresh()

Reload a fresh model instance from the database.

QueryableModel
newFromBuilder(array $attributes = [])

Create a new model instance that is existing.

static QueryableModel
create(array $attributes = [])

Saves a new model

QueryableModel
newInstance(array $attributes = [], bool $exists = false)

Create a new instance of the given model.

array
getTagsAttribute(string|null $tags = null)

No description

void
setTagsAttribute(array $tags = [])

No description

static QueryableModel
firstOrCreate(array $query, array $with = [])

Retrieves the first matching model or creates it

static QueryableModel
firstOrNew(array $attributes = [])

Retrieves the first model, or creates a new instance if not found

bool
performUpdate()

Perform a model update operation.

mixed
withIgnoredPublishingStatus(callable $callback)

Perform an action with temporary disabled respectPublishingStatus

bool
performInsert()

Perform a model insert operation.

$this
syncOriginal()

Sync the original attributes with the current.

void
finishSave()

Perform any actions that are necessary after the model is saved.

bool
save()

Updates or stores the model

bool|null
delete()

Delete the model from the database.

static bool
destroy(mixed|array|Collection ...$identifiers)

Destroys one or multiple instances by primary key

void
performDeleteOnModel()

Perform the actual delete query on this model instance.

QueryableModel
replicate(array $except = null)

Clone the model into a new, non-existing instance.

array
jsonSerialize()

Convert the object into something JSON serializable.

bool
update(array $attributes = [])

Update the model

static QueryableModel
updateOrCreate(array $query, array $with = [])

Updates an exisisting model or creates it

$this
fill(array $attributes)

Fill the model with an array of attributes.

bool
is(QueryableModel $other)

No description

array
toArray()

Convert the model instance to an array.

string
toJson(int $options = 0)

Convert the model instance to JSON.

mixed
getRouteKey()

Get the value of the model's route key.

string
getRouteKeyName()

Get the route key for the model.

Model|null
resolveRouteBinding(mixed $rawValue, string|null $field = null)

Retrieve the model for a bound value.

Model|null
resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

bool
getIncrementing()

Get the value indicating whether the IDs are incrementing.

bool
offsetExists(mixed $offset)

No description

mixed
offsetGet(mixed $offset)

No description

void
offsetSet(mixed $offset, mixed $value)

No description

void
offsetUnset(mixed $offset)

No description

void
bootIfNotBooted()

Check if the model needs to be booted and if so, do it.

static void
boot()

Bootstrap the model and its traits.

static void
bootTraits()

Boot all of the bootable traits on the model.

mixed
__get(string $key)

Dynamically retrieve attributes on the model.

void
__set(string $key, mixed $value)

Dynamically set attributes on the model.

void
initializeTraits()

Initialize any initializable traits on the model.

mixed
getKey()

Get the value of the model's primary key.

string
getKeyName()

Get the primary key for the model.

$this
setKeyName(string $key)

Set the primary key for the model.

string
getKeyType()

Get the auto-incrementing key type.

$this
setKeyType(string $type)

Set the data type for the primary key.

static void
clearBootedModels()

Clear the list of booted models so they will be re-booted.

static mixed
__callStatic(string $method, array $parameters)

Handle dynamic static method calls into the method.

string
__toString()

Convert the model to its string representation.

void
__wakeup()

When a model is being unserialized, check if it needs to be booted.

static void
booting(Closure|string $callback)

Register a booting model event with the dispatcher.

static void
booted(Closure|string $callback)

Register a booted model event with the dispatcher.

bool
relationLoaded(string $key)

Shim to make model compatible with HasAttributes trait

bool
__isset(string $key)

No description

array
__debugInfo()

No description

Details

in HasRelation at line 15
string getRelation()

Gets the relation

Return Value

string

in HasRelation at line 26
int|null getRelationId()

Gets the relation_id

Return Value

int|null

in HasRelation at line 39
protected string getCacheIdentifier(mixed $identifier = null)

Creates a cacheKey

Parameters

mixed $identifier

Return Value

string

in HasRelation at line 56
protected getAllCacheIdentifier()

in ModelMapper at line 12
protected Closure getMapper()

Return Value

Closure

in Queryable at line 39
static protected Builder makeQueryBuilder($appends = [])

Parameters

$appends

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

in Queryable at line 99
bool respectPublishingStatus()

Determine if this object respects publishing statuses when performing queries

Return Value

bool

in Queryable at line 111
static Builder disregardingPublishingStatus(bool $disregarding = true)

Override the publishing status for the model

Parameters

bool $disregarding

Return Value

Builder

in Queryable at line 125
static Builder field(...$args)

Adds a field that should be retrieved

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::field

in Queryable at line 138
static Builder fields(...$args)

Sets which fields to retrieve (default: All fields)

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::fields

in Queryable at line 151
static Builder limit(...$args)

Limits the results to $limit amount of hits

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::limit

in Queryable at line 166
static Builder orderBy(...$args)

Sets the field which to order the results by

Parameters

...$args

Return Value

Builder

Exceptions

InvalidSortingDirectionException If an invalid $direction is passed
NotQueryableException If object not queryable

See also

Builder::orderBy

in Queryable at line 179
static Builder raw(...$args)

Performs a raw query, use carefully.

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::raw

in Queryable at line 192
static Builder publishedAt(...$args)

Performs a 'publishedAt' query

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::publishedAt

in Queryable at line 210
static Builder where(...$args)

Performs a 'where' query

If a closure is passed as the only argument, a new query scope will be created. If $value is omitted, $operator is used as the $value, and the $operator will be set to '='.

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::where

in Queryable at line 224
static Builder whereIn(...$args)

Queries where field exists in the values

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::whereIn

in Queryable at line 242
static Builder whereNot(...$args)

Performs a 'whereNot' query

If a closure is passed as the only argument, a new query scope will be created. If $value is omitted, $operator is used as the $value, and the $operator will be set to '='.

Parameters

...$args

Return Value

Builder

Exceptions

NotQueryableException If object not queryable

See also

Builder::whereNot

in Queryable at line 257
static whereBetween(...$args)

Parameters

...$args

in Queryable at line 272
static whereNotBetween(...$args)

Parameters

...$args

in Queryable at line 287
static Paginator paginate(...$args)

Creates a paginated result

Parameters

...$args

Return Value

Paginator

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

See also

Builder::paginate

in Queryable at line 303
static mixed maybeMutatesCache(string $key, bool $shouldCache, Closure $action)

Perform an action and mutate the given key if $shouldCache is true

Parameters

string $key
bool $shouldCache
Closure $action

Return Value

mixed

in Queryable at line 320
static Builder maybeCacheResults(string $key, bool $shouldCache)

Cache the results with the given key if $shouldCache is true

Parameters

string $key
bool $shouldCache

Return Value

Builder

See also

Builder::cacheResultsWithKey

in Queryable at line 336
static Builder cacheResults(string $key)

Cache the results with the given key

Parameters

string $key

Return Value

Builder

See also

Builder::cacheResultsWithKey

in Queryable at line 349
static int count(...$args)

Get the count of items matching the current query

Parameters

...$args

Return Value

int

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

See also

Builder::count

in Queryable at line 360
static Queryable|Collection random(int $amount = 1)

Picks random items

Parameters

int $amount

Return Value

Queryable|Collection

in Queryable at line 372
static Builder query(string $query = '*')

Parameters

string $query

Return Value

Builder

Exceptions

NotQueryableException

in Resolvable at line 20
protected getPrimaryField()

in Resolvable at line 26
protected getResolvableField()

in Resolvable at line 39
static protected mixed resolvableContext(Closure $context)

Exectures the context if object can be resolved

Parameters

Closure $context

Return Value

mixed

Exceptions

NotQueryableException If object not queryable

in Resolvable at line 55
static Resolvable|null first()

Retrieves the first instance

Return Value

Resolvable|null

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 71
static Resolvable firstOrFail()

Retrieves the first instance or fails

Return Value

Resolvable

Exceptions

NotFoundException If not found
NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 90
static Resolvable|null last()

Retrieves the latest instance

Return Value

Resolvable|null

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 105
static Collection|LazyCollection all()

Retrieves all instances

Return Value

Collection|LazyCollection

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 121
static chunked($chunkSize = null)

Parameters

$chunkSize

at line 812
static QueryableModel|Collection|null resolve($rawValue, string|null $field = null)

Resolves an instance

Parameters

$rawValue
string|null $field

Return Value

QueryableModel|Collection|null

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 168
static Resolvable|Collection resolveOrFail(mixed $resolveBy)

Resolves an instance or throws an exception

Parameters

mixed $resolveBy

Return Value

Resolvable|Collection

Exceptions

ResolutionFailedException If the instance(s) could not be resolved
NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 185
static Collection resolveMany(array $resolveBy)

Resolves multiple instances by their primary fields

Parameters

array $resolveBy

Return Value

Collection

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 198
static Resolvable|Collection|null find(mixed|array|Collection $findBy)

Finds an instance by its primary field

Parameters

mixed|array|Collection $findBy

Return Value

Resolvable|Collection|null

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 225
static Resolvable|Collection findOrFail(mixed|array $findBy)

Finds an instance by its primary field or throws an exception

Parameters

mixed|array $findBy

Return Value

Resolvable|Collection

Exceptions

NotFoundException If the instance(s) could not be found
NotQueryableException If object not queryable
QueryException On invalid query

in Resolvable at line 245
static Collection findMany(array $findBy)

Finds multiple instances by their primary fields

Parameters

array $findBy

Return Value

Collection

Exceptions

NotQueryableException If object not queryable
QueryException On invalid query

at line 188
__construct(array $attributes = [], bool $boot = true)

Parameters

array $attributes
bool $boot Should this model boot it's bootable traits and emit events?

at line 205
APIClient getConnection()

Get the api connection for the model.

Return Value

APIClient

at line 215
string|null getConnectionName()

Get the current connection name for the model.

Return Value

string|null

at line 226
$this setConnection(string|null $name)

Set the connection associated with the model.

Parameters

string|null $name

Return Value

$this

at line 240
protected array|null performRetrieveRequest(int|null $relationId = null, mixed $key)

Retrieves a record by key

Parameters

int|null $relationId
mixed $key

Return Value

array|null

at line 252
protected mixed performInsertRequest(int|null $relationId = null, array $attributes = [])

Inserts a new record, and returns its id

Parameters

int|null $relationId
array $attributes

Return Value

mixed

at line 265
protected void performUpdateRequest(int|null $relationId = null, mixed $key, array $attributes = [])

Updates a record

Parameters

int|null $relationId
mixed $key
array $attributes

Return Value

void

at line 277
protected bool performDeleteRequest(int|null $relationId = null, mixed $key)

Deletes a record

Parameters

int|null $relationId
mixed $key

Return Value

bool

at line 287
QueryableModel|null fresh()

Reload a fresh model instance from the database.

Return Value

QueryableModel|null

at line 313
QueryableModel newFromBuilder(array $attributes = [])

Create a new model instance that is existing.

Parameters

array $attributes

Return Value

QueryableModel

at line 330
static QueryableModel create(array $attributes = [])

Saves a new model

Parameters

array $attributes

Return Value

QueryableModel

at line 346
QueryableModel newInstance(array $attributes = [], bool $exists = false)

Create a new instance of the given model.

Parameters

array $attributes
bool $exists

Return Value

QueryableModel

at line 359
array getTagsAttribute(string|null $tags = null)

Parameters

string|null $tags

Return Value

array

at line 368
void setTagsAttribute(array $tags = [])

Parameters

array $tags

Return Value

void

at line 380
static QueryableModel firstOrCreate(array $query, array $with = [])

Retrieves the first matching model or creates it

Parameters

array $query
array $with

Return Value

QueryableModel

at line 405
static QueryableModel firstOrNew(array $attributes = [])

Retrieves the first model, or creates a new instance if not found

Parameters

array $attributes

Return Value

QueryableModel

at line 419
protected bool performUpdate()

Perform a model update operation.

Return Value

bool

at line 458
protected mixed withIgnoredPublishingStatus(callable $callback)

Perform an action with temporary disabled respectPublishingStatus

Parameters

callable $callback

Return Value

mixed

at line 473
protected bool performInsert()

Perform a model insert operation.

Return Value

bool

at line 509
$this syncOriginal()

Sync the original attributes with the current.

Return Value

$this

at line 522
protected void finishSave()

Perform any actions that are necessary after the model is saved.

Return Value

void

at line 534
bool save()

Updates or stores the model

Return Value

bool

at line 561
bool|null delete()

Delete the model from the database.

Return Value

bool|null

Exceptions

Exception

at line 586
static bool destroy(mixed|array|Collection ...$identifiers)

Destroys one or multiple instances by primary key

Parameters

mixed|array|Collection ...$identifiers

Return Value

bool

at line 605
protected void performDeleteOnModel()

Perform the actual delete query on this model instance.

Return Value

void

at line 621
QueryableModel replicate(array $except = null)

Clone the model into a new, non-existing instance.

Parameters

array $except

Return Value

QueryableModel

at line 646
array jsonSerialize()

Convert the object into something JSON serializable.

Return Value

array

at line 657
bool update(array $attributes = [])

Update the model

Parameters

array $attributes

Return Value

bool

at line 673
static QueryableModel updateOrCreate(array $query, array $with = [])

Updates an exisisting model or creates it

Parameters

array $query
array $with

Return Value

QueryableModel

at line 701
$this fill(array $attributes)

Fill the model with an array of attributes.

Parameters

array $attributes

Return Value

$this

Exceptions

MassAssignmentException

at line 724
bool is(QueryableModel $other)

Parameters

QueryableModel $other

Return Value

bool

at line 734
array toArray()

Convert the model instance to an array.

Return Value

array

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

Convert the model instance to JSON.

Parameters

int $options

Return Value

string

Exceptions

JsonEncodingException

at line 763
mixed getRouteKey()

Get the value of the model's route key.

Return Value

mixed

at line 773
string getRouteKeyName()

Get the route key for the model.

Return Value

string

at line 786
Model|null resolveRouteBinding(mixed $rawValue, string|null $field = null)

Retrieve the model for a bound value.

Parameters

mixed $rawValue
string|null $field

Return Value

Model|null

Exceptions

NotFoundException

at line 832
Model|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

Retrieve the child model for a bound value.

Parameters

string $childType
mixed $value
string|null $field

Return Value

Model|null

at line 842
bool getIncrementing()

Get the value indicating whether the IDs are incrementing.

Return Value

bool

at line 851
bool offsetExists(mixed $offset)

Parameters

mixed $offset

Return Value

bool

at line 860
mixed offsetGet(mixed $offset)

Parameters

mixed $offset

Return Value

mixed

at line 870
void offsetSet(mixed $offset, mixed $value)

Parameters

mixed $offset
mixed $value

Return Value

void

at line 879
void offsetUnset(mixed $offset)

Parameters

mixed $offset

Return Value

void

at line 889
protected void bootIfNotBooted()

Check if the model needs to be booted and if so, do it.

Return Value

void

at line 906
static protected void boot()

Bootstrap the model and its traits.

Return Value

void

at line 916
static protected void bootTraits()

Boot all of the bootable traits on the model.

Return Value

void

at line 942
mixed __get(string $key)

Dynamically retrieve attributes on the model.

Parameters

string $key

Return Value

mixed

at line 954
void __set(string $key, mixed $value)

Dynamically set attributes on the model.

Parameters

string $key
mixed $value

Return Value

void

at line 964
protected void initializeTraits()

Initialize any initializable traits on the model.

Return Value

void

at line 976
mixed getKey()

Get the value of the model's primary key.

Return Value

mixed

at line 986
string getKeyName()

Get the primary key for the model.

Return Value

string

at line 997
$this setKeyName(string $key)

Set the primary key for the model.

Parameters

string $key

Return Value

$this

at line 1009
string getKeyType()

Get the auto-incrementing key type.

Return Value

string

at line 1020
$this setKeyType(string $type)

Set the data type for the primary key.

Parameters

string $type

Return Value

$this

at line 1032
static void clearBootedModels()

Clear the list of booted models so they will be re-booted.

Return Value

void

at line 1044
static mixed __callStatic(string $method, array $parameters)

Handle dynamic static method calls into the method.

Parameters

string $method
array $parameters

Return Value

mixed

at line 1054
string __toString()

Convert the model to its string representation.

Return Value

string

at line 1064
void __wakeup()

When a model is being unserialized, check if it needs to be booted.

Return Value

void

at line 1075
static protected void booting(Closure|string $callback)

Register a booting model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 1088
static protected void booted(Closure|string $callback)

Register a booted model event with the dispatcher.

Parameters

Closure|string $callback

Return Value

void

at line 1101
protected bool relationLoaded(string $key)

Shim to make model compatible with HasAttributes trait

Parameters

string $key

Return Value

bool

at line 1110
bool __isset(string $key)

Parameters

string $key

Return Value

bool

at line 1118
array __debugInfo()

Return Value

array