Documentation · ViewHelper reference


This ViewHelper generates a HTML dump of the tagged variable.






All Features

<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>


[A HTML view of the var_dump]

  • Tag usage example

    <f:debug title="NULL" maxDepth="123" plainText="1" ansiColors="1" inline="1" blacklistedClassNames="{foo: 'bar'}" blacklistedPropertyNames="{foo: 'bar'}">
    	<!-- tag content - may be ignored! -->
  • Inline usage example

    {f:debug(title: 'NULL', maxDepth: 123, plainText: 1, ansiColors: 1, inline: 1, blacklistedClassNames: {foo: 'bar'}, blacklistedPropertyNames: {foo: 'bar'})}


Argument Description Type

If TRUE, ANSI color codes is added to the plaintext output, if FALSE (default) the plaintext debug output not colored.


An array of class names (RegEx) to be filtered. Default is an array of some common class names.


An array of property names and/or array keys (RegEx) to be filtered. Default is an array of some common property names.


if TRUE, the dump is rendered at the position of the tag. If FALSE (default), the dump is displayed at the top of the page.


Sets the max recursion depth of the dump (defaults to 8). De- or increase the number according to your needs and memory limit.


If TRUE, the dump is in plain text, if FALSE the debug output is in HTML format.


optional custom title for the debug output

Required attribute

Revision history

commit 20f666791c21fab92964d28e0cda7b3b06eb36a3
Author: Claus Due <*****>
Date:   Sat Nov 23 17:18:35 2013 +0100

    [FEATURE] ViewHelper Debug ViewHelper
    ViewHelper can be used to debug other view helpers to read their argument names and descriptions, and the arguments you provided.
    {someArray -> v:iterator.first() -> v:debug()}
    <v:debug>{someArray -> v:iterator.first()}</v:debug>
    Outputs, for each child ViewHelper ``v:debug`` gets as tag content:
    - VH doc comment
    - list of allowed arguments
    - list of argument values (the "final" values given to the VH)
    - closer description of ``render()`` function
    You can "debug" any ViewHelper this way - ones from the core, from VHS or any other package. You can use it to ensure that the arguments you are passing are getting the correct values after Fluid transforms them to whichever value type you required. And of course it allows a very quick reference to see possible arguments when you don't have any other documentation or don't know which version to look up in docs.

commit d2e531da034976e6db1478eef5a8478595fd16fe
Author: Claus Due <*****>
Date:   Sun Jan 5 00:45:10 2014 +0100

    [TASK] Migrate to using namespace core class names

commit da7677bc74f14e9a9300e4ba4487e52c3cb97642
Author: Claus Due <*****>
Date:   Sun Apr 20 01:13:33 2014 +0200

    [TASK] Switch to namespaces

commit 12ff0ddfb8d36c51f2d3befde7ae812177c80d5d
Author: Xaver Maierhofer <*****>
Date:   Wed Jun 11 00:01:47 2014 +0200

    [TASK] CGL remove use leading backslash
    PHP Docs
    Note that for namespaced names (fully qualified namespace names containing namespace separator, such as Foo\Bar as opposed to global names that do not, such as FooBar),
    the leading backslash is unnecessary and not recommended, as import names must be fully qualified, and are not processed relative to the current namespace.

commit 2944721a3f9d6c31b3164cb3337958d0fdf764d6
Author: Claus Due <*****>
Date:   Fri Jan 16 18:32:10 2015 +0100

    [FEATURE] Allow v:debug to debug ObjectAccessors and values

commit 8bb2fc5ee124ba19b0a0ab8e061c9a153fc4651f
Author: Xaver Maierhofer <*****>
Date:   Sun Jan 18 17:56:13 2015 +0100

    [TASK] Reference Copyright to file

commit 97a64e7405af9d95b88c59199e2824f0696f12f4
Author: Claus Due <*****>
Date:   Sun Jan 25 05:41:16 2015 +0100

    [TASK] Fix CGL error

commit f8d2c8f885635465beaa9644bf8c7cdcbe7f815e
Author: Claus Due <*****>
Date:   Mon Jan 26 00:50:37 2015 +0100

    [TASK] Don't use a referenced variable where not needed