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.
Methods
Constructor
__construct(\XenForo_ViewRenderer_Abstract $renderer, \Zend_Controller_Response_Http $response, array $params, string $templateName)
Inherited
| inherited_from |
\XenForo_View::__construct() |
| inherited_from |
\XenForo_ViewAdmin_Base::__construct() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::__construct() |
Parameters
$response
\Zend_Controller_Response_HttpResponse object
$templateName
stringTemplate name to render (possibly ignored)
Creates the HTML template object to render this view's own specified template,
using the given params.
createOwnTemplateObject() : \XenForo_Template_Abstract
Inherited
| inherited_from |
\XenForo_View::createOwnTemplateObject() |
| inherited_from |
\XenForo_ViewAdmin_Base::createOwnTemplateObject() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::createOwnTemplateObject() |
Returns
Creates an HTML template object for rendering using the view renderer.
createTemplateObject(string $templateName, array $params) : \XenForo_Template_Abstract
Inherited
| inherited_from |
\XenForo_View::createTemplateObject() |
| inherited_from |
\XenForo_ViewAdmin_Base::createTemplateObject() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::createTemplateObject() |
Parameters
$templateName
stringName of the template to create
$params
arrayKey-value parameters to pass to the template
Returns
Gets the view params.
getParams() : array
Inherited
| inherited_from |
\XenForo_View::getParams() |
| inherited_from |
\XenForo_ViewAdmin_Base::getParams() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::getParams() |
Returns
array
Gets the view template name
getTemplateName() : string
Inherited
| inherited_from |
\XenForo_View::getTemplateName() |
| inherited_from |
\XenForo_ViewAdmin_Base::getTemplateName() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::getTemplateName() |
Returns
string
Pre-loads the specified template.
preLoadTemplate(string $template)
Inherited
| inherited_from |
\XenForo_View::preLoadTemplate() |
| inherited_from |
\XenForo_ViewAdmin_Base::preLoadTemplate() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::preLoadTemplate() |
Parameters
$template
string
This is a global param preparation method.
prepareParams()
Inherited
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() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::prepareParams() |
renderHtml()
renderHtml()
Inherited
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::renderHtml() |
Tells the browser that the data should be downloaded (rather than displayed)
using the specified file name.
setDownloadFileName(string $fileName, boolean $inline)
Inherited
| inherited_from |
\XenForo_View::setDownloadFileName() |
| inherited_from |
\XenForo_ViewAdmin_Base::setDownloadFileName() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::setDownloadFileName() |
Parameters
$fileName
string
$inline
booleanTrue if the attachment should be shown inline - use with caution!
Add an array of params to the view.
setParams(array $params)
Inherited
Overwrites parameters with the same name.
| inherited_from |
\XenForo_View::setParams() |
| inherited_from |
\XenForo_ViewAdmin_Base::setParams() |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::setParams() |
Parameters
$params
array
Properties
$_params : array
Inherited
| inherited_from |
\XenForo_View::$$_params |
| inherited_from |
\XenForo_ViewAdmin_Base::$$_params |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::$$_params |
$_renderer : \XenForo_ViewRenderer_Abstract
Inherited
| inherited_from |
\XenForo_View::$$_renderer |
| inherited_from |
\XenForo_ViewAdmin_Base::$$_renderer |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::$$_renderer |
$_response : \Zend_Controller_Response_Http
Inherited
Should be used to modify headers/state as necessary
| inherited_from |
\XenForo_View::$$_response |
| inherited_from |
\XenForo_ViewAdmin_Base::$$_response |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::$$_response |
$_templateName : string
Inherited
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 |
| inherited_from |
\XenForo_ViewAdmin_Node_Edit::$$_templateName |