Handles front controller dependencies for install/upgrade pages.

package XenForo_Mvc

 Methods

Determines if the controller matched by the route can be dispatched.

allowControllerDispatch(mixed $controller, string $action) : boolean

Use this function to ensure, for example, that an admin page only shows an admin controller.

Parameters

$controller

mixed

Likely a XenForo_Controller object, but not guaranteed

$action

string

Name of the action to call

Returns

boolean

Helper method to create a template object for rendering.

createTemplateObject(string $templateName, array $params) : \XenForo_Template_Admin

Parameters

$templateName

string

Name of the template to be used

$params

array

Key-value parameters to pass to the template

Returns

Gets the base view class name for this type.

getBaseViewClassName() : string

Returns

string

Gets the effective set of container params.

getEffectiveContainerParams(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.

see \XenForo_Dependencies_Abstract::getEffectiveContainerParams

Parameters

$params

array

Container params from the controller/view

$request

\Zend_Controller_Request_Http

Returns

array

Gets extra container data from template renders.

getExtraContainerData() : array

Returns

array

Fetch the path / URL to the jQuery core library

getJquerySource(boolean $forceLocal) : string
InheritedStatic
inherited_from \XenForo_Dependencies_Abstract::getJquerySource()

Parameters

$forceLocal

boolean

If true, forces the local version of jQuery

Returns

string

Gets the routing information for a not found error

getNotFoundErrorRoute() : array

Returns

arrayFormat: [0] => controller name, [1] => action

Gets the routing information for a search error

getServerErrorRoute() : array

Returns

arrayFormat: [0] => controller name, [1] => action

Creates the view renderer for a specified response type.

getViewRenderer(\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.

Parameters

$response

\Zend_Controller_Response_Http

Response object

$responseType

string

Type of response

$request

\Zend_Controller_Request_Http

Request object

Returns

Merge view state changes over any existing states.

mergeViewStateChanges(array $states) 
Inherited
inherited_from \XenForo_Dependencies_Abstract::mergeViewStateChanges()

Parameters

$states

array

Key-value pairs

Pre-loads globally required data for the system.

preLoadData() 

Performs any pre-view rendering setup, such as getting style information and ensuring the correct data is registered.

preRenderView(\XenForo_ControllerResponse_Abstract $controllerResponse) 

Parameters

$controllerResponse

\XenForo_ControllerResponse_Abstractnull

Preloads a template with the template handler for use later.

preloadTemplate(string $templateName) 

Parameters

$templateName

string

Template name

Routes the request.

route(\Zend_Controller_Request_Http $request) : \XenForo_RouteMatch
see \XenForo_Dependencies_Abstract::route()

Parameters

$request

\Zend_Controller_Request_Http

Returns

Gets cron-related params for the container.

_getCronContainerParams() : array
Inherited
inherited_from \XenForo_Dependencies_Abstract::_getCronContainerParams()

Returns

array

Handles the custom data that needs to be preloaded.

_handleCustomPreloadedData(array $data) 
Inherited
inherited_from \XenForo_Dependencies_Abstract::_handleCustomPreloadedData()

Parameters

$data

array

Data that was loaded. Unsuccessfully loaded items will have a value of null

 Properties

 

$templateClass 
 

$_dataPreLoadFromRegistry : array
Inherited

You must process this data via _handleCustomPreLoadedData().

inherited_from \XenForo_Dependencies_Abstract::$$_dataPreLoadFromRegistry
 

$_defaultTemplateParams : array
Inherited

Conflicting params are overridden by specific template params.

inherited_from \XenForo_Dependencies_Abstract::$$_defaultTemplateParams
 

$_viewStateChanges : array
Inherited

This will be used to modify how view rendering is done. For example, pages that want an explicit style ID can set it here.

inherited_from \XenForo_Dependencies_Abstract::$$_viewStateChanges