Controller

The CMS controller class.

 class Cms\Classes\Controller

# Traits

# Properties

# public $vars : array = []

# protected $componentContext : Cms\Classes\ComponentBase

# protected static $instance : self

# protected $layout : Cms\Classes\Layout

# protected $layoutObj : Cms\Classes\CodeBase

# protected $page : Cms\Classes\Page

# protected $pageContents : string

# protected $pageObj : Cms\Classes\CodeBase

# protected $partialStack : PartialStack

# protected $router : Cms\Classes\Router

# protected $theme : Cms\Classes\Theme

# protected $twig : TwigEnvironment

# inherited public $assetPath : string

# inherited protected $assets : array = {"js":[],"css":[],"rss":[],"vite":[]}

# inherited protected $orderFactor : integer

# inherited protected $responseHeaderBag : Symfony\Component\HttpFoundation\ResponseHeaderBag = null

# inherited protected $responseOverride : mixed = null

# inherited protected $statusCode : int = 200

# Methods

# public __construct (Cms\Classes\Theme $theme = null) : void

# public addComponent (mixed $name, string $alias, array $properties, boolean $addToLayout = false) : ComponentBase | null

# public currentPageUrl (array $parameters = [], boolean $routePersistence = true) : null | string

# public findComponentByHandler (string $handler) : ComponentBase

# public findComponentByName (mixed $name) : ComponentBase

# public findComponentByPartial (string $partial) : ComponentBase | null

# public getAjaxHandler () : string

# public static getController () : self | null

# public getLayout () : Cms\Classes\Layout

# public getLayoutObject () : Cms\Classes\CodeBase

# public getLoader () : Cms\Twig\Loader

# public getPage () : Cms\Classes\Page

# public getPageObject () : Cms\Classes\CodeBase

# public getRouter () : Cms\Classes\Router

# public getTheme () : Cms\Classes\Theme

# public getTwig () : TwigEnvironment

# public pageCycle ()

# public pageUrl (mixed $name, array $parameters = [], boolean $routePersistence = true) : string | null

# public param (string $name, string $default = null) : string

# public static render (string $pageFile, array $parameters = [], Cms\Classes\Theme $theme = null) : mixed

# public renderComponent (mixed $name, array $parameters = []) : string

# public renderContent (string $name, array $parameters = [], boolean $throwException = true) : string | false

# public renderPage ()

# public renderPartial (string $name, array $parameters = [], boolean $throwException = true) : mixed

# public run (string $url = "\/") : BaseResponse

# public runPage (Cms\Classes\Page $page, boolean $useAjax = true) : mixed

# public setComponentContext (ComponentBase $component = null) : void

# public themeUrl (mixed $url = null) : string

# protected execAjaxHandlers () : mixed

# protected execPageCycle ()

# protected initComponents () : void

# protected initCustomObjects () : void

# protected initTwigEnvironment () : void

# protected isSoftComponent (string $label) : bool

# protected parseComponentLabel (string $label) : string

# protected postProcessResult (Cms\Classes\Page $page, string $url, string $content) : string

# protected runAjaxHandler (string $handler) : bool

# protected setComponentPropertiesFromParams (ComponentBase $component, array $parameters = [])

# protected themeCombineAssets (array $url) : string

# inherited public addCss (string | array $name, array $attributes = []) : void

# inherited public addJs (string | array $name, array $attributes = []) : void

# inherited public addRss (string $name, array $attributes = []) : void

# inherited public addVite (array | string $entrypoints, ?string $package = null) : void

# inherited public combineAssets (array $assets, string $localPath = "") : string

# inherited public fireSystemEvent (string $event, array $params = [], boolean $halt = true) : mixed

$this->fireSystemEvent('backend.list.myEvent', ['my value']);

$this->fireEvent('list.myEvent', ['myvalue'], true);

Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);

# inherited public fireViewEvent (string $event, array $params = []) : string

# inherited public flushAssets () : void

# inherited public getAssetPath (string $fileName, $assetPath = null) : string

# inherited public getAssetPaths () : array

# inherited public getResponseHeaders () : Symfony\Component\HttpFoundation\ResponseHeaderBag | null

# inherited public getStatusCode () : int

# inherited public hasAssetsDefined () : bool

# inherited public makeAssets ($type = null) : string | null

# inherited public makeResponse (mixed $contents) : mixed

# inherited public orderAssets (array $assets) : array

# inherited public setResponse (mixed $response) : $this

# inherited public setResponseCookie (Symfony\Component\HttpFoundation\Cookie | mixed $cookie) : $this

# inherited public setResponseHeader (string $key, array | string $values, boolean $replace = true) : $this

# inherited public setStatusCode (int $code) : $this

# inherited protected addAsset (string $type, string $path, array $attributes) : void

# inherited protected getAssetEntryBuildPath (array $asset) : string

# inherited protected getAssetScheme (string $asset) : string

# inherited protected getLocalPath (string | null $relativePath) : string

# inherited protected makeXsrfCookie () : Symfony\Component\HttpFoundation\Cookie

# inherited protected removeDuplicates () : void

# inherited protected verifyCsrfToken () : bool

# inherited protected verifyForceSecure () : bool