Skip to content
Find forgotten variables dump in PHP source code.
PHP
Branch: master
Clone or download
This branch is 6 commits ahead, 1 commit behind JakubOnderka:master.

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
.travis.yml
LICENSE
README.md
composer.json
phpunit.xml
var-dump-check
var-dump-check.php

README.md

PHP VarDump Check

PHP console application for find forgotten variable dump. Support PHP build in method print_r, var_dump and var_export method and also method from Tracy debugger, Ladybug, Symfony, Laravel, Doctrine and Zend Framework.

Install

Just create a composer.json file and run the php composer.phar install command to install it:

{
    "require-dev": {
        "jakub-onderka/php-var-dump-check": "~0.3"
    }
}

For colored output install suggested package jakub-onderka/php-console-highlighter.

Usage and example output

$ ./vendor/bin/var-dump-check --no-colors --tracy .
...................X...

Checked 23 files in 0.1 second, dump found in 1 file

------------------------------------------------------------
Forgotten dump 'var_dump' found in ./test.php:36
    34|         $functionsToCheck = $this->prepareFunctionCheck($this->settings->functionsToCheck);
    35|
  > 36| 	    var_dump($functionsToCheck);
    37|
    38|         foreach ($tokens as $key => $token) {

Options for run

  • none - check dump: var_dump, var_export, print_r
  • --ladybug - check dump: ladybug_dump, ladybug_dump_die, ld, ldd
  • --tracy - check dump: dump, bdump, Debugger::dump, Debugger::barDump
  • --zend - check dump: Zend_Debug::dump, \Zend\Debug\Debug::dump
  • --doctrine - check dump: Doctrine::dump, \Doctrine\Common\Util\Debug::dump
  • --symfony - check dump: dump, VarDumper::dump, VarDumper::setHandler, VarDumper::dd
  • --laravel - check dump: dd, dump
  • --custom-function - comma separated custom function name(s) to check like pre_echo
  • --no-colors - disable colors from output
  • --exclude folder/ - exclude folder/ from check
  • --extensions php,phpt,php7 - map file extensions for check

Recommended setting for usage with Symfony framework

For run from command line:

$ ./vendor/bin/var-dump-check --symfony --exclude app --exclude vendor .

or setting for ANT:

<condition property="var-dump-check" value="${basedir}/bin/var-dump-check.bat" else="${basedir}/bin/var-dump-check">
    <os family="windows"/>
</condition>

<target name="var-dump-check" description="Run PHP VarDump check">
    <exec executable="${var-dump-check}" failonerror="true">
        <arg line='--exclude ${basedir}/app/' />
        <arg line='--exclude ${basedir}/vendor/' />
        <arg line='${basedir}' />
    </exec>
</target>

Build Status Downloads this Month Latest stable

You can’t perform that action at this time.