Go to file
Jeff Welch e62663cae7 It begins. 2013-02-04 23:07:53 -05:00
src/PHPExporter It begins. 2013-02-04 23:07:53 -05:00
tests/PHPExporter It begins. 2013-02-04 23:07:53 -05:00
.gitignore It begins. 2013-02-04 23:07:53 -05:00
LICENSE It begins. 2013-02-04 23:07:53 -05:00
README.md It begins. 2013-02-04 23:07:53 -05:00
composer.json It begins. 2013-02-04 23:07:53 -05:00
phpunit.xml.dist It begins. 2013-02-04 23:07:53 -05:00

README.md

PHPExporter

PHPExporter is a utility for getting textual representations of PHP values.

<?php
require_once __DIR__.'/../vendor/autoload.php';

use PHPExporter\Exporter;

// 46
echo Exporter::export(46);

// 4.0
echo Exporter::export(4.0);

// 'hello, world!'
echo Exporter::export('hello, world!');

// false
echo Exporter::export(false);

// NAN
echo Exporter::export(acos(8));

// -INF
echo Exporter::export(log(0));

// null
echo Exporter::export(null);

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

/*
Array &0 (
    0 => Array &1 (
        0 => 1
        1 => 2
        2 => 3
    )
    1 => Array &2 (
        0 => ''
        1 => 0
        2 => false
    )
)
*/
echo Exporter::export(array(array(1,2,3), array("",0,FALSE)));


// Array with references
// ----------------------
$array = array();
$array['self'] = &$array;
echo Exporter::export($array);
/*
Array &0 (
    'self' => Array &1 (
        'self' => Array &1
    )
)
*/


// Object with references
// ----------------------
$obj = new stdClass();
$obj->self = $obj;
echo Exporter::export($obj);
/*
stdClass Object &0000000003a66dcc0000000025e723e2 (
    'self' => stdClass Object &0000000003a66dcc0000000025e723e2
)
*/


// Kitchen Sink
// ------------
$obj2 = new stdClass;
$obj2->foo = 'bar';
$obj = new stdClass;
$obj->null = NULL;
$obj->boolean = TRUE;
$obj->integer = 1;
$obj->double = 1.2;
$obj->string = '1';
$obj->text = "this\nis\na\nvery\nvery\nvery\nvery\nvery\nvery\rlong\n\rtext";
$obj->object = $obj2;
$obj->objectagain = $obj2;
$obj->array = array('foo' => 'bar');
$obj->self = $obj;
$array = array(
    0 => 0,
    'null' => NULL,
    'boolean' => TRUE,
    'integer' => 1,
    'double' => 1.2,
    'string' => '1',
    'text' => "this\nis\na\nvery\nvery\nvery\nvery\nvery\nvery\rlong\n\rtext",
    'object' => $obj2,
    'objectagain' => $obj2,
    'array' => array('foo' => 'bar'),
);
$array['self'] = &$array;
echo Exporter::export($array);
/*
Array &0 (
    0 => 0
    'null' => null
    'boolean' => true
    'integer' => 1
    'double' => 1.2
    'string' => '1'
    'text' => 'this
is
a
very
very
very
very
very
very
long
text'
    'object' => stdClass Object &000000007ed49b01000000006907e890 (
        'foo' => 'bar'
    )
    'objectagain' => stdClass Object &000000007ed49b01000000006907e890
    'array' => Array &1 (
        'foo' => 'bar'
    )
    'self' => Array &2 (
        0 => 0
        'null' => null
        'boolean' => true
        'integer' => 1
        'double' => 1.2
        'string' => '1'
        'text' => 'this
is
a
very
very
very
very
very
very
long
text'
        'object' => stdClass Object &000000007ed49b01000000006907e890
        'objectagain' => stdClass Object &000000007ed49b01000000006907e890
        'array' => Array &3 (
            'foo' => 'bar'
        )
        'self' => Array &2
    )
)
*/

PHPExporter works with PHP 5.3.3 or later.

Installation

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

{
    "require": {
        "phpexporter/phpexporter": "1.0.*@dev"
    }
}

Tests

To run the test suite, you need composer.

$ php composer.phar install --dev
$ phpunit

Acknowledgements

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

License

PHPExporter is licensed under the BSD 3-Clause license.