Urls
class Urls extends DashboardSitePageController (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 | |
| protected | $site | from DashboardSitePageController |
Methods
Adds an item to the view's header. This item will then be automatically printed out before the
section of the page.Adds an item to the view's footer. This item will then be automatically printed out before the section of the page.
Override this method to perform controller initializations.
Given either a path or a Page object, this is a shortcut to
- Grab the controller of THAT page.
Set the custom request path (useful when replacing controllers).
Get the custom request path (useful when replacing controllers).
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).
Should this page be displayed using the user's language?
Dashboard page view.
Updates the .htaccess file (if writable).
Details
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
shouldRunControllerTask()
No description
getHelperObjects()
No description
get($key = null, $defaultValue = null)
No description
getTask()
No description
getAction()
No description
getParameters()
No description
on_start()
Override this method to perform controller initializations.
on_before_render()
No description
isPost()
deprecated
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
- Grab the controller of THAT page.
- Grab the view of THAT controller
- Render that view.
- Exit – so we immediately stop all other output in the controller that called render().
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?
enableNativeMobile()
No description
getEntityManager()
No description
protected
getSite()
No description
view(string|bool $strStatus = false, bool $prettyUrlState = '')
Dashboard page view.
save_urls()
Updates the .htaccess file (if writable).