TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper:

Public Member Functions
	render ($title=null, $maxDepth=8, $plainText=false, $ansiColors=false, $inline=false, $blacklistedClassNames=null, $blacklistedPropertyNames=null)
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	setArguments (array $arguments)
	setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
	injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
	isEscapingInterceptorEnabled ()
	setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
	setRenderChildrenClosure (\Closure $renderChildrenClosure)
	initializeArgumentsAndRender ()
	initialize ()
	renderChildren ()
	prepareArguments ()
	validateArguments ()
	initializeArguments ()
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
	resetState ()
Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)

Static Public Member Functions
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

Additional Inherited Members
Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	registerArgument ($name, $type, $description, $required=false, $defaultValue=null)
	overrideArgument ($name, $type, $description, $required=false, $defaultValue=null)
	callRenderMethod ()
	getLogger ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)
Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = null
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = true

Detailed Description

This ViewHelper generates a HTML dump of the tagged variable.

= Examples =

<f:debug>{testVariables.array}</f:debug> <output> foobarbazfoo </output>

<f:debug title="My Title" maxDepth="5" blacklistedClassNames="{0:'Tx_BlogExample_Domain_Model_Administrator'}" plainText="TRUE" ansiColors="FALSE" inline="TRUE" blacklistedPropertyNames="{0:'posts'}">{blogs}</f:debug> <output> [A HTML view of the var_dump] </output>

Definition at line 41 of file DebugViewHelper.php.

Member Function Documentation

render()

TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper::render	(		$title = null,
			$maxDepth = 8,
			$plainText = false,
			$ansiColors = false,
			$inline = false,
			$blacklistedClassNames = null,
			$blacklistedPropertyNames = null
	)

A wrapper for ::var_dump().

Parameters

string	$title	optional custom title for the debug output
int	$maxDepth	Sets the max recursion depth of the dump (defaults to 8). De- or increase the number according to your needs and memory limit.
bool	$plainText	If TRUE, the dump is in plain text, if FALSE the debug output is in HTML format.
bool	$ansiColors	If TRUE, ANSI color codes is added to the plaintext output, if FALSE (default) the plaintext debug output not colored.
bool	$inline	if TRUE, the dump is rendered at the position of the <f:debug> tag. If FALSE (default), the dump is displayed at the top of the page.
array	$blacklistedClassNames	An array of class names (RegEx) to be filtered. Default is an array of some common class names.
array	$blacklistedPropertyNames	An array of property names and/or array keys (RegEx) to be filtered. Default is an array of some common property names.

Returns

string

Definition at line 55 of file DebugViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\buildRenderChildrenClosure().

renderStatic()

static TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper::renderStatic ( array  $arguments, \Closure  $renderChildrenClosure, RenderingContextInterface  $renderingContext  )

static

Parameters

array	$arguments
callable	$renderChildrenClosure
RenderingContextInterface	$renderingContext

Returns

string

Definition at line 79 of file DebugViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$renderChildrenClosure, and TYPO3\CMS\Extbase\Utility\DebuggerUtility\var_dump().