PHP_Exporter

PHPUnit includes a nifty utility for visualizing and diffing PHP data types. PHP_Exporter is simply a stand-alone version of that utility.

Usage

Exporting:

<?php
use JeffWelch\PHP\Exporter;

/*
Exception Object &0000000078de0f0d000000002003a261 (
    'message' => ''
    'string' => ''
    'code' => 0
    'file' => '/home/whatthejeff/test.php'
    'line' => 34
    'trace' => Array &0 ()
    'previous' => null
)
*/

print new Exporter(new Exception);

Diffing:

<?php
use JeffWelch\PHP\Exporter;

/*
--- Original
+++ New
@@ @@
-Exception Object &000000000e4b5f5a0000000028315dc8 (
+Exception Object &000000000e4b5f5d0000000028315dc8 (
     'message' => ''
     'string' => ''
     'code' => 0
     'file' => '/home/whatthejeff/test.php'
-    'line' => 34
+    'line' => 35
     'trace' => Array &0 ()
     'previous' => null
 )
*/

$exporter = new Exporter(new Exception);
print $exporter->diff(new Exception);

Data Types

Exporting simple types:

<?php
use JeffWelch\PHP\Exporter;

// 46
print new Exporter(46);

// 4.0
print new Exporter(4.0);

// 'hello, world!'
print new Exporter('hello, world!');

// false
print new Exporter(false);

// NAN
print new Exporter(acos(8));

// -INF
print new Exporter(log(0));

// null
print new Exporter(null);

// resource(13) of type (stream)
print new Exporter(fopen('php://stderr', 'w'));

// Binary String: 0x000102030405
print new Exporter(chr(0) . chr(1) . chr(2) . chr(3) . chr(4) . chr(5));

Exporting complex types:

<?php
use JeffWelch\PHP\Exporter;

/*
Array &0 (
    0 => Array &1 (
        0 => 1
        1 => 2
        2 => 3
    )
    1 => Array &2 (
        0 => ''
        1 => 0
        2 => false
    )
)
*/

print new Exporter(array(array(1,2,3), array("",0,FALSE)));

/*
Array &0 (
    'self' => Array &1 (
        'self' => Array &1
    )
)
*/

$array = array();
$array['self'] = &$array;
print new Exporter($array);

/*
stdClass Object &0000000003a66dcc0000000025e723e2 (
    'self' => stdClass Object &0000000003a66dcc0000000025e723e2
)
*/

$obj = new stdClass();
$obj->self = $obj;
print new Exporter($obj);

Compact exports:

<?php
use JeffWelch\PHP\Exporter;

// Array ()
$exporter = new Exporter(array());
print $exporter->shortenedExport();

// Array (...)
$exporter = new Exporter(array(1,2,3,4,5));
print $exporter->shortenedExport();

// stdClass Object ()
$exporter = new Exporter(new stdClass);
print $exporter->shortenedExport();

// Exception Object (...)
$exporter = new Exporter(new Exception);
print $exporter->shortenedExport();

// this\nis\na\nsuper\nlong\nstring\nt...\nspace
$exporter = new Exporter(
<<<LONG_STRING
this
is
a
super
long
string
that
wraps
a
lot
and
eats
up
a
lot
of
space
LONG_STRING
);
print $exporter->shortenedExport();

Requirements

PHP_Exporter works with PHP 5.3.3 or later.

Installation

The recommended way to install PHP_Exporter is through composer. Just create a composer.json file and run the php composer.phar install command to install it:

{
    "require": {
        "php-exporter/php-exporter": "1.0.*@dev"
    }
}

Tests

To run the test suite, you need composer.

$ php composer.phar install --dev
$ vendor/bin/phpunit

Acknowledgements

This utility was adapted from the PHPUnit project. A special thanks goes to the following people for their contributions:

• sebastianbergmann
• edorian
• LawnGnome
• bschussek

License

PHP_Exporter is licensed under the BSD 3-Clause license.