TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\DebugViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper Tx_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)
 
 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 ()
 

Additional Inherited Members

- 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)
 
- 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 ()
 
 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 35 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 Tx_Extbase_Utility_Debugger::var_dump().

Parameters
string$titleoptional custom title for the debug output
integer$maxDepthSets the max recursion depth of the dump (defaults to 8). De- or increase the number according to your needs and memory limit.
boolean$plainTextIf TRUE, the dump is in plain text, if FALSE the debug output is in HTML format.
boolean$ansiColorsIf TRUE, ANSI color codes is added to the plaintext output, if FALSE (default) the plaintext debug output not colored.
boolean$inlineif 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$blacklistedClassNamesAn array of class names (RegEx) to be filtered. Default is an array of some common class names.
array$blacklistedPropertyNamesAn 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 49 of file DebugViewHelper.php.

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