class PageController extends Controller (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from  ApplicationAwareTrait
protected $helpers from  AbstractController
protected $sets from  AbstractController
protected $action
protected $request from  AbstractController
protected $parameters
protected $view from  Controller
protected $viewPath from  Controller
protected $theme from  Controller
protected $controllerActionPath from  Controller
protected $themeViewTemplate from  Controller
protected $supportsPageCache
protected $passThruBlocks
protected $replacement
protected $requestValidated
protected array $restrictedMethods

array of method names that can't be called through the url

protected string|null $customRequestPath

Custom request path - overrides Request::getPath() (useful when replacing controllers).

Page $c

Methods

setApplication(Application $app)

Setter method for the application

__construct(Page $c)

No description

mixed
getRequest()

No description

setRequest(mixed $request)

No description

requireAsset()

No description

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

set($key, $val)

No description

getSets()

No description

getHelperObjects()

No description

get($key = null, $defaultValue = null)

No description

getTask()

No description

getAction()

No description

getParameters()

No description

on_start()

No description

on_before_render()

No description

isPost() deprecated

No description

post($key = null, $defaultValue = null)

No description

redirect()

No description

runTask($action, $parameters)

No description

runAction($action, $parameters = array())

No description

request($key = null)

No description

setViewObject(AbstractView $view)

No description

setTheme($mixed)

No description

getTheme()

No description

setThemeViewTemplate($template)

No description

getThemeViewTemplate()

No description

getControllerActionPath()

No description

getViewObject()

No description

action()

No description

supportsPageCache()

No description

replace($var)

Given either a path or a Page object, this is a shortcut to

  1. Grab the controller of THAT page.

setCustomRequestPath(string|null $requestPath)

Set the custom request path (useful when replacing controllers).

string|null
getCustomRequestPath()

Get the custom request path (useful when replacing controllers).

isReplaced()

No description

getReplacement()

No description

render($path, $pkgHandle = null)

Given a path to a single page, this command uses the CURRENT controller and renders the contents of the single page within this request. The current controller is not replaced, and has already fired (since it is meant to be called from within a view() or similar method).

getPageObject()

No description

flash($key, $value, $isHTML = false)

No description

getRequestAction()

No description

getRequestActionParameters()

No description

setupRequestActionAndParameters(Request $request)

No description

isValidControllerTask($action, $parameters = array())

No description

setPassThruBlockController(Block $b, BlockController $controller)

No description

getPassThruBlockController(Block $b)

No description

validateRequest()

No description

bool
useUserLocale()

Should this page be displayed using the user's language?

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(Page $c)

No description

Parameters

Page $c

mixed getRequest()

No description

Return Value

mixed

setRequest(mixed $request)

No description

Parameters

mixed $request

requireAsset()

No description

addHeaderItem(string $item)

Adds an item to the view's header. This item will then be automatically printed out before the section of the page.

Parameters

string $item

addFooterItem(string $item)

Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.

Parameters

string $item

set($key, $val)

No description

Parameters

$key
$val

getSets()

No description

shouldRunControllerTask()

No description

getHelperObjects()

No description

get($key = null, $defaultValue = null)

No description

Parameters

$key
$defaultValue

getTask()

No description

getAction()

No description

getParameters()

No description

on_start()

No description

on_before_render()

No description

isPost() deprecated

deprecated

No description

post($key = null, $defaultValue = null)

No description

Parameters

$key
$defaultValue

redirect()

No description

runTask($action, $parameters)

No description

Parameters

$action
$parameters

runAction($action, $parameters = array())

No description

Parameters

$action
$parameters

request($key = null)

No description

Parameters

$key

setViewObject(AbstractView $view)

No description

Parameters

AbstractView $view

setTheme($mixed)

No description

Parameters

$mixed

getTheme()

No description

setThemeViewTemplate($template)

No description

Parameters

$template

getThemeViewTemplate()

No description

getControllerActionPath()

No description

getViewObject()

No description

action()

No description

supportsPageCache()

No description

replace($var)

Given either a path or a Page object, this is a shortcut to

  1. Grab the controller of THAT page.

  1. Grab the view of THAT controller
  2. Render that view.
  3. Exit – so we immediately stop all other output in the controller that called render().

Parameters

$var

setCustomRequestPath(string|null $requestPath)

Set the custom request path (useful when replacing controllers).

Parameters

string|null $requestPath

Set to null to use the default request path

string|null getCustomRequestPath()

Get the custom request path (useful when replacing controllers).

Return Value

string|null

Returns null if no custom request path, a string otherwise

isReplaced()

No description

getReplacement()

No description

render($path, $pkgHandle = null)

Given a path to a single page, this command uses the CURRENT controller and renders the contents of the single page within this request. The current controller is not replaced, and has already fired (since it is meant to be called from within a view() or similar method).

Parameters

$path
$pkgHandle

getPageObject()

No description

flash($key, $value, $isHTML = false)

No description

Parameters

$key
$value
$isHTML

getRequestAction()

No description

getRequestActionParameters()

No description

setupRequestActionAndParameters(Request $request)

No description

Parameters

Request $request

isValidControllerTask($action, $parameters = array())

No description

Parameters

$action
$parameters

setPassThruBlockController(Block $b, BlockController $controller)

No description

Parameters

Block $b
BlockController $controller

getPassThruBlockController(Block $b)

No description

Parameters

Block $b

validateRequest()

No description

bool useUserLocale()

Should this page be displayed using the user's language?

Return Value

bool