1. Documentation
  2. API
  3. Cms
  4. Classes
  5. CodeBase

Cms\Classes\CodeBase

Overview

CodeBase is a parent class for PHP classes created for layout and page code sections.

Extends
Implements
  • ArrayAccess

Public Properties

public Cms\Classes\Page $page

page object

public Cms\Classes\Layout $layout

layout object

public Cms\Classes\controller $controller

controller object

public array $vars

vars is a list of variables passed to the page.

Show inherited public properties

Inherited Public Properties

Protected Properties

There are no protected properties in the class.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __call()

public __call(string $method, array $parameters): mixed

__call dynamically handles calls to this classes behaviors, the page and layout object methods, and finally the controller instance.

public __construct()

public __construct(
    Cms\Classes\Page $page,
    Cms\Classes\Layout $layout,
    Cms\Classes\Controller $controller
): void

__construct the object instance.

public __get()

public __get(string $name): void

__get is referenced as $this->page in Cms\Classes\ComponentBase, so to avoid $this->page->page this method will proxy there. This is also used as a helper for accessing controller variables/components easier in the page code, eg. $this->foo instead of $this['foo']

public __isset()

public __isset(string $name): bool

__isset checks if a property is set on the CMS Page object.

public __set()

public __set(string $name, mixed $value): void

__set a property on the CMS Page object.

public offsetExists()

public offsetExists($offset): bool

offsetExists implementation

public offsetGet()

public offsetGet($offset): mixed

offsetGet implementation

public offsetSet()

public offsetSet($offset, $value): void

offsetSet implementation

public offsetUnset()

public offsetUnset($offset): void

offsetUnset implementation

public onEnd()

public onEnd(): void

onEnd is triggered in the end of the execution cycle, but before the page is displayed. The layout's onEnd method triggers after the page's onEnd method.

public onInit()

public onInit(): void

onInit is triggered when all components are initialized and before AJAX is handled. The layout's onInit method triggers before the page's onInit method.

public onStart()

public onStart(): void

onStart is triggered in the beginning of the execution cycle. The layout's onStart method triggers before the page's onStart method.

Show inherited public methods

Inherited Public Methods

Protected Methods

Show inherited protected methods

Inherited Protected Methods