Page - October CMS

Cms\Classes\Page

Overview

Page template class

Extends

Implements

ArrayAccess
Illuminate\Contracts\Support\Arrayable
Illuminate\Contracts\Support\Jsonable
JsonSerializable
Stringable
Cms\Contracts\CmsObject

Public Properties

public array $apiBag

The API bag allows the API handler code to bind arbitrary data to the page object.

public array $rules

rules to be applied to the data.

Show inherited public properties

Protected Properties

protected string $dirName

dirName associated with the model, eg: pages.

protected array $fillable

The attributes that are mass assignable.

protected array $parsable

parsable attributes support using parsed variables.

protected array $parsableAttributes

parsableAttributes contains the translated attributes

protected mixed $translatableBagCache

translatableBagCache store for the getTranslatableBag method.

Show inherited protected properties

Public Methods

public __get()

public __get($key): void

__get with parsable attribute override.

public addParsable()

public addParsable($attributes = null): void

addParsable attributes for the model

public applyTranslatableContext()

public applyTranslatableContext(
    System\Models\SiteDefinition|null $site = null
): void

applyTranslatableContext overrides page attributes with translated values for a site.

public beforeValidate()

public beforeValidate(): void

beforeValidate applies custom validation rules

public getCodeClassParent()

public getCodeClassParent(): mixed

getCodeClassParent returns name of a PHP class to us a parent for the PHP class created for the object's PHP section.

public getLayoutOptions()

public getLayoutOptions(): array

getLayoutOptions returns a list of layouts available in the theme. This method is used by the form widget.

public static getMenuTypeInfo()

public static getMenuTypeInfo(string $type): array

getMenuTypeInfo handler for the cms.pageLookup.getTypeInfo event. Returns a menu item type information. The type information is returned as array with the following elements:

references - a list of the item type reference options. The options are returned in the ["key"] => "title" format for options that don't have sub-options, and in the format ["key"] => ["title"=>"Option title", "items"=>[...]] for options that have sub-options. Optional, required only if the menu item type requires references.
nesting - Boolean value indicating whether the item type supports nested items. Optional, false if omitted.
dynamicItems - Boolean value indicating whether the item type could generate new menu items. Optional, false if omitted.
cmsPages - a list of CMS pages (objects of the Cms\Classes\Page class), if the item type requires a CMS page reference to resolve the item URL.

public static getNameList()

public static getNameList(): array

getNameList helper that returns a nicer list of pages for use in dropdowns.

public getParsableAttributeValues()

public getParsableAttributeValues(): array

getParsableAttributes

public getTranslatableBag()

public getTranslatableBag(): Cms\Components\TranslatableBag

getTranslatableBag returns the configured translatable component.

public getTranslatableUrl()

public getTranslatableUrl(
    System\Models\SiteDefinition|null $site = null
): string|null

getTranslatableUrl returns the translated URL pattern for a site, if available.

public getTranslatableValue()

public getTranslatableValue(
    string $name,
    System\Models\SiteDefinition|null $site = null
): string|null

getTranslatableValue returns a translated property value for a site, if available. The name avoids the get*Attribute convention since translatable is a real attribute.

public static resolveMenuItem()

public static resolveMenuItem(
    Cms\Models\PageLookupItem $item,
    string $url,
    Cms\Classes\Theme $theme
): mixed

resolveMenuItem handler for the cms.pageLookup.resolveItem event. Returns information about a menu item. The result is an array with the following keys:

url - the menu item URL. Not required for menu item types that return all available records. The URL should be returned relative to the website root and include the subdirectory, if any. Use the Url::to() helper to generate the URLs.
isActive - determines whether the menu item is active. Not required for menu item types that return all available records.
items - an array of arrays with the same keys (url, isActive, items) + the title key. The items array should be added only if the $item's $nesting property value is TRUE.

public setParsableAttribute()

public setParsableAttribute($key, $value): void

public static url()

public static url($page, $params = []): void

Show inherited public methods

Protected Methods

protected isTranslatableEnabled()

protected isTranslatableEnabled(): bool

isTranslatableEnabled checks the multisite page translation feature is active.

Show inherited protected methods

Inherited Protected Methods

afterBoot() - is called after the model is constructed for the first time. (defined in October\Rain\Halcyon\Model)
afterCreate() - handles the "created" model event. (defined in October\Rain\Halcyon\Model)
afterDelete() - handles the "deleted" model event. (defined in October\Rain\Halcyon\Model)
afterInit() - is called after the model is constructed, a nicer version. (defined in October\Rain\Halcyon\Model)
afterSave() - handles the "saved" model event. (defined in October\Rain\Halcyon\Model)
afterUpdate() - handles the "updated" model event. (defined in October\Rain\Halcyon\Model)
beforeCreate() - handles the "creating" model event. (defined in October\Rain\Halcyon\Model)
beforeDelete() - handles the "deleting" model event. (defined in October\Rain\Halcyon\Model)
beforeFetch() - handles the "fetching" model event. (defined in October\Rain\Halcyon\Model)
beforeUpdate() - handles the "updating" model event. (defined in October\Rain\Halcyon\Model)
boot() - the model. (defined in Cms\Classes\CmsObject)
bootDefaultTheme() - and all of the bootable traits on the model. (defined in Cms\Classes\CmsObject)
bootIfNotBooted() - checks if the model needs to be booted and if so, do it. (defined in October\Rain\Halcyon\Model)
bootNicerEvents() - binds some nicer events to this model, in the format of method overrides. (defined in October\Rain\Halcyon\Model)
bootTraits() - boots all of the bootable traits on the model. (defined in October\Rain\Halcyon\Model)
booted() - performs any actions required after the model boots. (defined in October\Rain\Halcyon\Model)
booting() - performs any actions required before the model boots. (defined in October\Rain\Halcyon\Model)
checkSafeMode() - checks if safe mode is enabled by config, and the code. (defined in Cms\Classes\CmsCompoundObject)
emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in October\Rain\Halcyon\Model)
extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
fillViewBagArray() - copies view bag properties to the view bag array. (defined in Cms\Classes\CmsCompoundObject)
fillableFromArray() - gets the fillable attributes of a given array. (defined in October\Rain\Halcyon\Model)
finishSave() - Finish processing on a successful save operation. (defined in October\Rain\Halcyon\Model)
fireModelEvent() - for the model. (defined in October\Rain\Halcyon\Model)
getArrayableAppends() - gets all of the appendable values that are arrayable. (defined in October\Rain\Halcyon\Model)
getAttributeFromArray() - gets an attribute from the $attributes array. (defined in October\Rain\Halcyon\Model)
getComponentPropertyGeneration() - returns the current cache generation for a theme. (defined in Cms\Classes\CmsCompoundObject)
getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
getValidationAttributes() - returns the model data used for validation. (defined in Cms\Classes\CmsObject)
initializeModelEvent() - is called every time the model is constructed. (defined in October\Rain\Halcyon\Model)
initializeTraits() - on the model. (defined in October\Rain\Halcyon\Model)
makeComponentPropertyCacheKey() - for this object. Each object caches under its. (defined in Cms\Classes\CmsCompoundObject)
makeComponentPropertyGenerationKey() - (defined in Cms\Classes\CmsCompoundObject)
makeValidator() - instantiates the validator used by the validation process, depending if the class is being used inside or. (defined in Cms\Classes\CmsObject)
mutateAttribute() - gets the value of an attribute using its mutator. (defined in October\Rain\Halcyon\Model)
mutateAttributeForArray() - gets the value of an attribute using its mutator for array conversion. (defined in October\Rain\Halcyon\Model)
originalIsNumericallyEquivalent() - determine if the new and old values for a given key are. (defined in October\Rain\Halcyon\Model)
parseComponentSettings() - parses component sections. (defined in Cms\Classes\CmsCompoundObject)
parseSettings() - array. (defined in Cms\Classes\CmsCompoundObject)
performDeleteOnModel() - performs the actual delete query on this model instance. (defined in October\Rain\Halcyon\Model)
performInsert() - Perform a model insert operation. (defined in October\Rain\Halcyon\Model)
performUpdate() - Perform a model update operation. (defined in October\Rain\Halcyon\Model)
processRuleFieldNames() - converts any field names using array notation. (defined in Cms\Classes\CmsObject)
processValidationRules() - (defined in Cms\Classes\CmsObject)
registerModelEvent() - with the dispatcher. (defined in October\Rain\Halcyon\Model)
throwHalcyonException() - Converts an exception type thrown by Halcyon to a native CMS exception. (defined in Cms\Classes\CmsObject)
validateSettings() - if the model is loaded with an invalid INI section, the invalid content. (defined in Cms\Classes\CmsCompoundObject)

Contents