ModelSites module

CacheEntry

CacheFile

A model in the Sites module, with 12 members for templates, 9 API properties and 12 members for admin templates.

Sites\Models\Frontend\CacheEntry Sites\Models\Api\CacheEntry Sites\Models\Backend\CacheEntry Also in Sites: CacheList CacheRecord Client Environment Hostname Request Site SiteData VcsConfig VcsLog
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 12

Take no arguments.

# getUrl()
?string
Returns the url of the cache entry based on the primary (or alternatively first) hostname of the associated environment and the provided path. Also considers whether the current system is a dev system, and modifies the hostname accordingly.
# getId()
?int
# getPath()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getClient()
?Client
# getEnvironment()
?Environment
# getRecords()
?Collection<CacheRecord>
# getLists()
?Collection<CacheList>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 9

Read-only values on the record.

# url
?string
Returns the url of the cache entry based on the primary (or alternatively first) hostname of the associated environment and the provided path. Also considers whether the current system is a dev system, and modifies the hostname accordingly.
# id
?int
# path
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# client
?Client
# environment
?Environment

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 12

Take no arguments.

# getUrl()
?string
Returns the url of the cache entry based on the primary (or alternatively first) hostname of the associated environment and the provided path. Also considers whether the current system is a dev system, and modifies the hostname accordingly.
# getId()
?int
# getPath()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getClient()
?Client
# getEnvironment()
?Environment
# getRecords()
?Collection<CacheRecord>
# getLists()
?Collection<CacheList>
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned