Neuron-PHP

Page extends Model

in package

• Neuron
• Cms
• Models

Page entity representing a CMS page with Editor.js content.

Table of Contents

Constants

STATUS_DRAFT  = 'draft'

Page status constants

STATUS_PUBLISHED  = 'published'

TEMPLATE_DEFAULT  = 'default'

Template constants

TEMPLATE_FULL_WIDTH  = 'full-width'

TEMPLATE_LANDING  = 'landing'

TEMPLATE_SIDEBAR  = 'sidebar'

Properties

$_loadedRelations  : array<string|int, mixed>

Loaded relations cache

$_pdo  : PDO|null

Database connection

$_relationCache  : array<string|int, mixed>

Relation metadata cache

$_author  : User|null

$_authorId  : int

$_contentRaw  : string

$_createdAt  : DateTimeImmutable|null

$_id  : int|null

$_metaDescription  : string|null

$_metaKeywords  : string|null

$_metaTitle  : string|null

$_publishedAt  : DateTimeImmutable|null

$_slug  : string

$_status  : string

$_template  : string

$_title  : string

$_updatedAt  : DateTimeImmutable|null

$_viewCount  : int

Methods

__construct()  : mixed

__get()  : mixed

Magic method to access relations.

all()  : array<string|int, mixed>

Get all models.

beginTransaction()  : bool

Begin a database transaction.

commit()  : bool

Commit the current transaction.

create()  : static

Create a new model and save it to the database.

delete()  : bool

Delete the model without handling dependents (simple delete).

destroy()  : bool

Delete the model from the database with dependent cascade.

destroyMany()  : int

Delete one or more models by ID.

exists()  : bool

Check if the model exists in the database.

fill()  : self

Fill the model with an array of attributes.

find()  : static|null

Find a model by primary key.

fromArray()  : static

Create Page from array data

getAttribute()  : mixed

Get an attribute value from the model.

getAuthor()  : User|null

Get author

getAuthorId()  : int

Get author ID

getContent()  : array<string|int, mixed>

Get content as array (decoded Editor.js JSON)

getContentRaw()  : string

Get raw content JSON string

getCreatedAt()  : DateTimeImmutable|null

Get created timestamp

getId()  : int|null

Get page ID

getMetaDescription()  : string|null

Get meta description (for SEO)

getMetaKeywords()  : string|null

Get meta keywords (for SEO)

getMetaTitle()  : string|null

Get meta title (for SEO)

getPrimaryKey()  : string

Get the primary key column name.

getPublishedAt()  : DateTimeImmutable|null

Get published date

getSlug()  : string

Get slug

getStatus()  : string

Get status

getTableName()  : string

Get the table name for this model from the Table attribute.

getTemplate()  : string

Get template

getTitle()  : string

Get title

getUpdatedAt()  : DateTimeImmutable|null

Get updated timestamp

getViewCount()  : int

Get view count

incrementViewCount()  : self

Increment view count

inTransaction()  : bool

Check if currently inside a transaction.

isDraft()  : bool

Check if page is draft

isPublished()  : bool

Check if page is published

limit()  : QueryBuilder

Set result limit.

loadRelations()  : void

Eager load relations.

offset()  : QueryBuilder

Set result offset.

orderBy()  : QueryBuilder

Add an order by clause.

query()  : QueryBuilder

Create a new query builder for this model.

relation()  : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

Get a relation instance (for calling sync/attach/detach methods).

rollBack()  : bool

Roll back the current transaction.

save()  : bool

Save the model to the database (insert or update).

setAttribute()  : void

Set an attribute value on the model.

setAuthor()  : self

Set author

setAuthorId()  : self

Set author ID

setContent()  : self

Set content from Editor.js JSON string

setContentArray()  : self

Set content from array (will be JSON encoded)

setCreatedAt()  : self

Set created timestamp

setId()  : self

Set page ID

setLoadedRelation()  : void

Set a loaded relation (used by eager loading).

setMetaDescription()  : self

Set meta description

setMetaKeywords()  : self

Set meta keywords

setMetaTitle()  : self

Set meta title

setPdo()  : void

Set the PDO connection for all models.

setPublishedAt()  : self

Set published date

setSlug()  : self

Set slug

setStatus()  : self

Set status

setTemplate()  : self

Set template

setTitle()  : self

Set title

setUpdatedAt()  : self

Set updated timestamp

setViewCount()  : self

Set view count

toArray()  : array<string|int, mixed>

Convert page to array

transaction()  : mixed

Execute a closure within a database transaction.

update()  : bool

Update the model's attributes and save to database.

where()  : QueryBuilder

Start a query with a where clause.

whereIn()  : QueryBuilder

Start a query with a where in clause.

with()  : QueryBuilder

Eager load relations.

createRelation()  : BelongsToRelation|HasManyRelation|HasOneRelation|BelongsToManyRelation

Create a relation instance.

getForeignKeyName()  : string

Get the foreign key name for this model.

getPdo()  : PDO

Get the PDO connection.

getPivotTableName()  : string

Get the pivot table name for a many-to-many relationship.

getRelatedForeignKeyName()  : string

Get the foreign key name for a related model.

getRelationMetadata()  : array<string|int, mixed>|null

Get relation metadata for a property.

handleDependentRelations()  : void

Handle dependent relations before destroying the model.

performInsert()  : bool

Perform an insert operation.

performUpdate()  : bool

Perform an update operation.

propertyToColumn()  : string

Convert property name to database column name.