Page
class Page extends QueryableModel implements Responsable
Traits
Constants
CREATED_AT |
The name of the "created at" column. |
UPDATED_AT |
The name of the "updated at" column. |
TYPE_DOMAIN |
|
TYPE_EXTERNAL |
|
TYPE_INTERNAL |
|
TYPE_FOLDER |
|
TYPE_PAGE |
|
Properties
protected string | $defaultOrderByField | Determines the default field to order the query by | |
protected string | $defaultSortDirection | Determines the default direction to order the query by | |
protected int | $perPage | The number of models to return for pagination. Also determines chunk size for LazyCollection | |
protected bool | $useChunking | Determines if QueryableModel::all() calls in queries should chunk the result. | from QueryableModel |
bool | $exists | Indicates if the model exists. | from QueryableModel |
bool | $wasRecentlyCreated | Indicates if the model was inserted during the current request lifecycle. | from QueryableModel |
static protected array | $traitInitializers | The array of trait initializers that will be called on each new instance. | from QueryableModel |
static protected array | $booted | The array of booted models. | from QueryableModel |
protected string | $attributes | The interal storage of the model data. | from QueryableModel |
protected string | $relation | The relation associated with the model. | |
protected int | $relationId | The directory_id associated with the model. | from QueryableModel |
protected string | $primaryField | The primary field for the model. | from QueryableModel |
protected string | $keyType | The "type" of the primary key ID. | from QueryableModel |
protected string | $resolvableField | The resolvable field associated with the model. | |
bool | $incrementing | Indicates if the IDs are auto-incrementing. | from QueryableModel |
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 | from QueryableModel |
protected bool | $cachesResults | Determines if we should cache some results. | from QueryableModel |
static protected Collection|null | $allItems | Holds all page objects Avoids recursive resolution of pages | |
bool | $timestamps | Indicates if the model should be timestamped. | |
protected array | $dates | The attributes that should be mutated to dates. | |
$hidden | The attributes that should be hidden for arrays. | ||
protected array | $fillable | The attributes that are mass assignable. | |
protected array | $guarded | The attributes that aren't mass assignable. | |
protected array | $appends | The accessors to append to the model's array form. | |
int | $id | ||
int | $directory_id | ||
string | $name | ||
string|null | $title | ||
string | $url | ||
int | $revision | ||
string | $created | ||
string | $updated | ||
bool | $published | ||
string|null | $author | ||
int | $userid | ||
bool | $use_time | ||
string|null | $start | ||
string|null | $stop | ||
array | $tags | ||
bool | $public | ||
mixed | $authgroups | ||
array | $variants | ||
Page|null | $master | ||
string|null | $lang |
Methods
Determine if this object respects publishing statuses when performing queries
Override the publishing status for the model
Perform an action and mutate the given key if $shouldCache is true
Cache the results with the given key if $shouldCache is true
Retrieves all instances
Resolves an instance
Resolves an instance or throws an exception
Resolves multiple instances by their primary fields
Finds an instance by its primary field
Finds an instance by its primary field or throws an exception
Finds multiple instances by their primary fields
Retrieves a record by key
Inserts a new record, and returns its id
Updates a record
Deletes a record
Create a new model instance that is existing.
Create a new instance of the given model.
Retrieves the first matching model or creates it
Retrieves the first model, or creates a new instance if not found
Perform an action with temporary disabled respectPublishingStatus
Perform any actions that are necessary after the model is saved.
Destroys one or multiple instances by primary key
Perform the actual delete query on this model instance.
Clone the model into a new, non-existing instance.
Updates an exisisting model or creates it
Retrieve the model for a bound value.
Retrieve the child model for a bound value.
Get the value indicating whether the IDs are incrementing.
Clear the list of booted models so they will be re-booted.
Handle dynamic static method calls into the method.
When a model is being unserialized, check if it needs to be booted.
Shim to make model compatible with HasAttributes trait
No description
Retrieves the component names of the given block
No description
No description
Gets the domain name of the page, using its master page as the base
No description
No description
No description
Create an HTTP response that represents the object.
Gets the parent page
Gets this page's children
Loads the given revision
Resolves navigation data for this page
Traverses the page graph and determines if the page is a subpage of another pzsage.
Traverses the page graph and determines if the page is a subpage of another pzsage.
Gets the config array as a object
Details
in
HasRelation at line 14
string
getRelation()
Gets the relation
in
HasRelation at line 24
int|null
getRelationId()
Gets the relation_id
in
HasRelation at line 36
protected string
getCacheIdentifier(mixed $identifier = null)
Creates a cacheKey
in
HasRelation at line 46
protected
getAllCacheIdentifier()
in
ModelMapper at line 12
protected Closure
getMapper()
in
Queryable at line 39
static protected Builder
makeQueryBuilder($appends = [])
in
Queryable at line 93
bool
respectPublishingStatus()
Determine if this object respects publishing statuses when performing queries
in
Queryable at line 104
static Builder
disregardingPublishingStatus(bool $disregarding = true)
Override the publishing status for the model
in
Queryable at line 118
static Builder
field(...$args)
Adds a field that should be retrieved
in
Queryable at line 131
static Builder
fields(...$args)
Sets which fields to retrieve (default: All fields)
in
Queryable at line 144
static Builder
limit(...$args)
Limits the results to $limit amount of hits
in
Queryable at line 159
static Builder
orderBy(...$args)
Sets the field which to order the results by
in
Queryable at line 172
static Builder
raw(...$args)
Performs a raw query, use carefully.
in
Queryable at line 190
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 '='.
in
Queryable at line 204
static Builder
whereIn(...$args)
Queries where field exists in the values
in
Queryable at line 222
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 '='.
in
Queryable at line 237
static
whereBetween(...$args)
in
Queryable at line 252
static
whereNotBetween(...$args)
in
Queryable at line 267
static Paginator
paginate(...$args)
Creates a paginated result
in
Queryable at line 283
static mixed
maybeMutatesCache(string $key, bool $shouldCache, Closure $action)
Perform an action and mutate the given key if $shouldCache is true
in
Queryable at line 300
static Builder
maybeCacheResults(string $key, bool $shouldCache)
Cache the results with the given key if $shouldCache is true
in
Queryable at line 316
static Builder
cacheResults(string $key)
Cache the results with the given key
in
Queryable at line 329
static int
count(...$args)
Get the count of items matching the current query
in
Queryable at line 352
static Builder
query(string $query = '*')
in
Resolvable at line 20
protected
getPrimaryField()
in
Resolvable at line 25
protected
getResolvableField()
in
Resolvable at line 37
static protected mixed
resolvableContext(Closure $context)
Exectures the context if object can be resolved
in
Resolvable at line 53
static Resolvable|null
first()
Retrieves the first instance
in
Resolvable at line 69
static Resolvable
firstOrFail()
Retrieves the first instance or fails
in
Resolvable at line 88
static Resolvable|null
last()
Retrieves the latest instance
at line 390
static Collection|LazyCollection
all()
Retrieves all instances
in
Resolvable at line 119
static
chunked($chunkSize = null)
at line 430
static QueryableModel|Collection|null
resolve(mixed $resolveBy, string|null $field = null)
Resolves an instance
in
Resolvable at line 166
static Resolvable|Collection
resolveOrFail(mixed $resolveBy)
Resolves an instance or throws an exception
in
Resolvable at line 183
static Collection
resolveMany(array $resolveBy)
Resolves multiple instances by their primary fields
at line 412
static Resolvable|Collection|null
find(int|string $id)
Finds an instance by its primary field
in
Resolvable at line 223
static Resolvable|Collection
findOrFail(mixed|array $findBy)
Finds an instance by its primary field or throws an exception
in
Resolvable at line 243
static Collection
findMany(array $findBy)
Finds multiple instances by their primary fields
in
QueryableModel at line 179
__construct(array $attributes = [], bool $boot = true)
at line 198
protected array|null
performRetrieveRequest(int|null $relationId = null, mixed $key)
Retrieves a record by key
at line 210
protected mixed
performInsertRequest(int|null $relationId = null, array $attributes = [])
Inserts a new record, and returns its id
at line 225
protected void
performUpdateRequest(int|null $relationId = null, mixed $key, array $attributes = [])
Updates a record
at line 237
protected bool
performDeleteRequest(int|null $relationId = null, mixed $key)
Deletes a record
in
QueryableModel at line 245
QueryableModel|null
fresh()
Reload a fresh model instance from the database.
in
QueryableModel at line 271
QueryableModel
newFromBuilder(array $attributes = [])
Create a new model instance that is existing.
in
QueryableModel at line 288
static QueryableModel
create(array $attributes = [])
Saves a new model
in
QueryableModel at line 304
QueryableModel
newInstance(array $attributes = [], bool $exists = false)
Create a new instance of the given model.
in
QueryableModel at line 317
array
getTagsAttribute(string|null $tags = null)
in
QueryableModel at line 326
void
setTagsAttribute(array $tags = [])
in
QueryableModel at line 338
static QueryableModel
firstOrCreate(array $query, array $with = [])
Retrieves the first matching model or creates it
in
QueryableModel at line 363
static QueryableModel
firstOrNew(array $attributes = [])
Retrieves the first model, or creates a new instance if not found
in
QueryableModel at line 377
protected bool
performUpdate()
Perform a model update operation.
in
QueryableModel at line 416
protected mixed
withIgnoredPublishingStatus(callable $callback)
Perform an action with temporary disabled respectPublishingStatus
in
QueryableModel at line 431
protected bool
performInsert()
Perform a model insert operation.
in
QueryableModel at line 467
$this
syncOriginal()
Sync the original attributes with the current.
in
QueryableModel at line 480
protected void
finishSave()
Perform any actions that are necessary after the model is saved.
in
QueryableModel at line 492
bool
save()
Updates or stores the model
in
QueryableModel at line 519
bool|null
delete()
Delete the model from the database.
in
QueryableModel at line 544
static bool
destroy(mixed|array|Collection ...$identifiers)
Destroys one or multiple instances by primary key
in
QueryableModel at line 563
protected void
performDeleteOnModel()
Perform the actual delete query on this model instance.
in
QueryableModel at line 579
QueryableModel
replicate(array $except = null)
Clone the model into a new, non-existing instance.
in
QueryableModel at line 604
array
jsonSerialize()
Convert the object into something JSON serializable.
in
QueryableModel at line 615
bool
update(array $attributes = [])
Update the model
in
QueryableModel at line 631
static QueryableModel
updateOrCreate(array $query, array $with = [])
Updates an exisisting model or creates it
in
QueryableModel at line 659
$this
fill(array $attributes)
Fill the model with an array of attributes.
in
QueryableModel at line 682
bool
is(QueryableModel $other)
in
QueryableModel at line 692
array
toArray()
Convert the model instance to an array.
in
QueryableModel at line 705
string
toJson(int $options = 0)
Convert the model instance to JSON.
in
QueryableModel at line 721
mixed
getRouteKey()
Get the value of the model's route key.
in
QueryableModel at line 731
string
getRouteKeyName()
Get the route key for the model.
in
QueryableModel at line 744
Model|null
resolveRouteBinding(mixed $rawValue, string|null $field = null)
Retrieve the model for a bound value.
in
QueryableModel at line 790
Model|null
resolveChildRouteBinding(string $childType, mixed $value, string|null $field)
Retrieve the child model for a bound value.
in
QueryableModel at line 800
bool
getIncrementing()
Get the value indicating whether the IDs are incrementing.
in
QueryableModel at line 809
bool
offsetExists(mixed $offset)
in
QueryableModel at line 818
mixed
offsetGet(mixed $offset)
in
QueryableModel at line 828
void
offsetSet(mixed $offset, mixed $value)
in
QueryableModel at line 837
void
offsetUnset(mixed $offset)
in
QueryableModel at line 847
protected void
bootIfNotBooted()
Check if the model needs to be booted and if so, do it.
in
QueryableModel at line 864
static protected void
boot()
Bootstrap the model and its traits.
in
QueryableModel at line 874
static protected void
bootTraits()
Boot all of the bootable traits on the model.
in
QueryableModel at line 900
mixed
__get(string $key)
Dynamically retrieve attributes on the model.
in
QueryableModel at line 912
void
__set(string $key, mixed $value)
Dynamically set attributes on the model.
in
QueryableModel at line 922
protected void
initializeTraits()
Initialize any initializable traits on the model.
in
QueryableModel at line 934
mixed
getKey()
Get the value of the model's primary key.
in
QueryableModel at line 944
string
getKeyName()
Get the primary key for the model.
in
QueryableModel at line 955
$this
setKeyName(string $key)
Set the primary key for the model.
in
QueryableModel at line 967
string
getKeyType()
Get the auto-incrementing key type.
in
QueryableModel at line 978
$this
setKeyType(string $type)
Set the data type for the primary key.
in
QueryableModel at line 990
static void
clearBootedModels()
Clear the list of booted models so they will be re-booted.
in
QueryableModel at line 1002
static mixed
__callStatic(string $method, array $parameters)
Handle dynamic static method calls into the method.
in
QueryableModel at line 1012
string
__toString()
Convert the model to its string representation.
in
QueryableModel at line 1022
void
__wakeup()
When a model is being unserialized, check if it needs to be booted.
in
QueryableModel at line 1033
static protected void
booting(Closure|string $callback)
Register a booting model event with the dispatcher.
in
QueryableModel at line 1046
static protected void
booted(Closure|string $callback)
Register a booted model event with the dispatcher.
in
QueryableModel at line 1059
protected bool
relationLoaded(string $key)
Shim to make model compatible with HasAttributes trait
in
QueryableModel at line 1068
bool
__isset(string $key)
in
QueryableModel at line 1076
array
__debugInfo()
in
CastsDefaultFields at line 11
static
bootCastsDefaultFields()
in
CastsDefaultFields at line 43
Collection
getContentAttribute(array $content = [])
in
CastsDefaultFields at line 50
getKeywordsAttribute($keywords)
in
CastsDefaultFields at line 56
setKeywordsAttribute($keywords)
in
CastsDefaultFields at line 65
string
getTypeAttribute()
in
CastsDefaultFields at line 89
string
getUrlAttribute(string $url)
in
CastsDefaultFields at line 109
array
getAuthGroupsAttribute(string $authgroups = '')
in
HidesDefaultFields at line 7
static
bootHidesDefaultFields()
at line 184
route($name, $parameters = [], $absolute = true)
at line 248
Collection
getBlocks(string $area)
Retrieves the component names of the given block
at line 264
bool
hasTemplate()
at line 270
getMasterAttribute()
at line 284
string|null
getDomainAttribute()
Gets the domain name of the page, using its master page as the base
at line 295
getLangAttribute()
at line 317
Template
getTemplateAttribute(int $template = null)
at line 328
string
getTitleAttribute(string $title)
at line 343
Response
toResponse(Request $request)
Create an HTTP response that represents the object.
at line 364
Page|null
getParentAttribute()
Gets the parent page
at line 374
collection
getChildrenAttribute()
Gets this page's children
at line 459
Page
loadRevision(int $revisionId = null)
Loads the given revision
at line 480
static Page|null
current()
Retrieves the current matched Page
at line 493
Collection
navigationData(string $type = 'nav', string|null $root = null)
Resolves navigation data for this page
at line 505
bool
isSubPageOf(Page $page, Page|null $pointer = null)
Traverses the page graph and determines if the page is a subpage of another pzsage.
at line 529
bool
isParentPageOf(Page $page)
Traverses the page graph and determines if the page is a subpage of another pzsage.
at line 539
static Page
model()
Resolves the registered Page model class
at line 551
object
getConfigAttribute(array|null $config = [])
Gets the config array as a object