class Users extends DashboardPageController (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from ApplicationAwareTrait
protected $helpers from DashboardPageController
protected $sets from AbstractController
protected $action from PageController
protected $request from AbstractController
protected $parameters from PageController
protected $view from Controller
protected $viewPath from Controller
protected $theme from Controller
protected $controllerActionPath from Controller
protected $themeViewTemplate from Controller
protected $supportsPageCache from PageController
protected $passThruBlocks from PageController
protected $replacement from PageController
protected $requestValidated from PageController
protected $restrictedMethods from DashboardPageController
protected string|null $customRequestPath Custom request path - overrides Request::getPath() (useful when replacing controllers). from PageController
Page $c from PageController
protected $error from DashboardPageController
Token $token from DashboardPageController
protected EntityManager $entityManager from DashboardPageController

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(@string|Page $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

setupRequestActionAndParameters(Request $request)

No description

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

No description

setPassThruBlockController(Block $b, BlockController $controller)

No description

validateRequest()

No description

getEntityManager()

No description

view()

No description

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(Page $c)

Parameters

Page $c

mixed getRequest()

Return Value

mixed

setRequest(mixed $request)

Parameters

mixed $request

requireAsset()

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)

Parameters

$key
$val

getSets()

shouldRunControllerTask()

getHelperObjects()

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

Parameters

$key
$defaultValue

getTask()

getAction()

getParameters()

on_start()

on_before_render()

isPost() deprecated

deprecated

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

Parameters

$key
$defaultValue

redirect()

runTask($action, $parameters)

Parameters

$action
$parameters

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

Parameters

$action
$parameters

request($key = null)

Parameters

$key

setViewObject(AbstractView $view)

Parameters

AbstractView $view

setTheme($mixed)

Parameters

$mixed

getTheme()

setThemeViewTemplate($template)

Parameters

$template

getThemeViewTemplate()

getControllerActionPath()

getViewObject()

action()

supportsPageCache()

replace(@string|Page $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

@string|Page $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()

getReplacement()

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()

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

Parameters

$key
$value
$isHTML

getRequestAction()

getRequestActionParameters()

setupRequestActionAndParameters(Request $request)

Parameters

Request $request

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

Parameters

$action
$parameters

setPassThruBlockController(Block $b, BlockController $controller)

Parameters

Block $b
BlockController $controller

getPassThruBlockController(Block $b)

Parameters

Block $b

validateRequest()

enableNativeMobile()

getEntityManager()

view()