allowControllerDispatch()
createTemplateObject()
getBaseViewClassName()
getEffectiveContainerParams()
getExtraContainerData()
getJquerySource()
getNotFoundErrorRoute()
getServerErrorRoute()
getViewRenderer()
mergeViewStateChanges()
preLoadData()
preRenderView()
preloadTemplate()
route()
_getCronContainerParams()
_handleCustomPreloadedData()
$_dataPreLoadFromRegistry
$_defaultTemplateParams
$_viewStateChanges
Interface for objects that can be passed into the front controller to load all of its dependencies.
| package | XenForo_Mvc |
|---|
allowControllerDispatch(mixed $controller, string $action) : boolean
Use this function to ensure, for example, that an admin page only shows an admin controller.
mixedLikely a XenForo_Controller object, but not guaranteed
stringName of the action to call
booleancreateTemplateObject(string $templateName, array $params) : \XenForo_Template_Abstract
stringName of the template to be used
arrayKey-value parameters to pass to the template
getBaseViewClassName() : string
stringgetEffectiveContainerParams(array $params, \Zend_Controller_Request_Http $request) : array
This includes combining and specific container params with any global ones. For example, a specific container param may refer to the section the page is in, so this function could load the other options that are specific to this section.
arrayContainer params from the controller/view
\Zend_Controller_Request_HttparraygetExtraContainerData() : array
arraygetJquerySource(boolean $forceLocal) : string
booleanIf true, forces the local version of jQuery
stringgetNotFoundErrorRoute() : array
arrayFormat: [0] => controller name, [1] => actiongetServerErrorRoute() : array
arrayFormat: [0] => controller name, [1] => actiongetViewRenderer(\Zend_Controller_Response_Http $response, string $responseType, \Zend_Controller_Request_Http $request) : \XenForo_ViewRenderer_Abstract | false
If an invalid type is specified, false is returned.
\Zend_Controller_Response_HttpResponse object
stringType of response
\Zend_Controller_Request_HttpRequest object
mergeViewStateChanges(array $states)
arrayKey-value pairs
preLoadData()
preRenderView(\XenForo_ControllerResponse_Abstract $controllerResponse)
preloadTemplate(string $templateName)
stringTemplate name
_getCronContainerParams() : array
array_handleCustomPreloadedData(array $data)
arrayData that was loaded. Unsuccessfully loaded items will have a value of null
$_dataPreLoadFromRegistry : array
You must process this data via _handleCustomPreLoadedData().
$_defaultTemplateParams : array
Conflicting params are overridden by specific template params.
$_viewStateChanges : array
This will be used to modify how view rendering is done. For example, pages that want an explicit style ID can set it here.