CmsObject
interface Cms\Contracts\CmsObjectMethods
public getBaseFileName () : string
Returns the file name without the extension.
Returns
string
public getContent () : string
Returns the file content.
Returns
string
public getFileName () : string
Returns the file name.
Returns
string
public
getFilePath (string $fileName = null)
: string
Returns the local file path to the template.
Parameters
| Property | Type | Description |
|---|---|---|
| $fileName | string |
string
|
Returns
string
public getTwigCacheKey () : string
Returns the key used by the Twig cache.
Returns
string
public getTwigContent () : string
Returns the Twig content string.
Returns
string
public static load (string $hostObj, string $fileName) : mixed
Loads the template.
Parameters
| Property | Type | Description |
|---|---|---|
| $hostObj | string |
string
|
| $fileName | string |
string
|
Returns
mixed
public static loadCached (string $hostObj, string $fileName) : mixed
Loads and caches the template.
Parameters
| Property | Type | Description |
|---|---|---|
| $hostObj | string |
string
|
| $fileName | string |
string
|
Returns
mixed
Implemented by
| Class | Description |
|---|---|
CmsCompoundObject
|
This is a base class for CMS objects that have multiple sections - pages, partials and layouts. |
CmsObject
|
This is a base class for all CMS objects - content files, pages, partials and layouts. |
ComponentPartial
|
The CMS component partial class. These objects are read-only. |
Content
|
The CMS content file class. |
Layout
|
The CMS layout class. |
Meta
|
The CMS meta file class, used for interacting with YAML files within the Halcyon datasources |
Page
|
The CMS page class. |
Partial
|
The CMS partial class. |
Theme
|
This class represents the CMS theme. |
Copyright © 2025 Winter CMS