Abstract base for views.
A child of this class is not required if you simply want to render an HTML template with no other processing.
Views must implement renderX methods, where X represents the response type they handle (eg, renderHtml or renderJson). These methods take no arguments and should return a string if they successfully rendered content or false if the content is really unrepresentable.
| package | XenForo_Mvc |
|---|
__construct(\XenForo_ViewRenderer_Abstract $renderer, \Zend_Controller_Response_Http $response, array $params, string $templateName)
| inherited_from | \XenForo_View::__construct() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::__construct() |
\Zend_Controller_Response_HttpResponse object
arrayView params
stringTemplate name to render (possibly ignored)
createOwnTemplateObject() : \XenForo_Template_Abstract
| inherited_from | \XenForo_View::createOwnTemplateObject() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::createOwnTemplateObject() |
createTemplateObject(string $templateName, array $params) : \XenForo_Template_Abstract
| inherited_from | \XenForo_View::createTemplateObject() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::createTemplateObject() |
stringName of the template to create
arrayKey-value parameters to pass to the template
getParams() : array
| inherited_from | \XenForo_View::getParams() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::getParams() |
arraygetTemplateName() : string
| inherited_from | \XenForo_View::getTemplateName() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::getTemplateName() |
stringpreLoadTemplate(string $template)
| inherited_from | \XenForo_View::preLoadTemplate() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::preLoadTemplate() |
string
prepareParams()
It is called for all view output types. It is also called even if the required renderX method is not available.
This method can be overridden to modify params and then let the code fallback to the behavior as if the view did not exist (by not defining the renderX method).
| inherited_from | \XenForo_View::prepareParams() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::prepareParams() |
renderHtml()
setDownloadFileName(string $fileName, boolean $inline)
| inherited_from | \XenForo_View::setDownloadFileName() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::setDownloadFileName() |
string
booleanTrue if the attachment should be shown inline - use with caution!
setParams(array $params)
Overwrites parameters with the same name.
| inherited_from | \XenForo_View::setParams() |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::setParams() |
array
_getLanguagesAsSelectList(array $languageTree, $depthModifier, $repeatText)
$_params : array
| inherited_from | \XenForo_View::$$_params |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::$$_params |
$_renderer : \XenForo_ViewRenderer_Abstract
| inherited_from | \XenForo_View::$$_renderer |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::$$_renderer |
$_response : \Zend_Controller_Response_Http
Should be used to modify headers/state as necessary
| inherited_from | \XenForo_View::$$_response |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::$$_response |
$_templateName : string
This can be used as is, as a basis, or just ignored entirely. Each view will handle it differently.
| inherited_from | \XenForo_View::$$_templateName |
|---|---|
| inherited_from | \XenForo_ViewAdmin_Base::$$_templateName |