Chris@0: Exporter
Chris@0: ========
Chris@0: 
Chris@0: [![Build Status](https://secure.travis-ci.org/sebastianbergmann/exporter.png?branch=master)](https://travis-ci.org/sebastianbergmann/exporter)
Chris@0: 
Chris@0: This component provides the functionality to export PHP variables for visualization.
Chris@0: 
Chris@0: ## Usage
Chris@0: 
Chris@0: Exporting:
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: use SebastianBergmann\Exporter\Exporter;
Chris@0: 
Chris@0: $exporter = new Exporter;
Chris@0: 
Chris@0: /*
Chris@0: Exception Object &0000000078de0f0d000000002003a261 (
Chris@0:     'message' => ''
Chris@0:     'string' => ''
Chris@0:     'code' => 0
Chris@0:     'file' => '/home/sebastianbergmann/test.php'
Chris@0:     'line' => 34
Chris@0:     'trace' => Array &0 ()
Chris@0:     'previous' => null
Chris@0: )
Chris@0: */
Chris@0: 
Chris@0: print $exporter->export(new Exception);
Chris@0: ```
Chris@0: 
Chris@0: ## Data Types
Chris@0: 
Chris@0: Exporting simple types:
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: use SebastianBergmann\Exporter\Exporter;
Chris@0: 
Chris@0: $exporter = new Exporter;
Chris@0: 
Chris@0: // 46
Chris@0: print $exporter->export(46);
Chris@0: 
Chris@0: // 4.0
Chris@0: print $exporter->export(4.0);
Chris@0: 
Chris@0: // 'hello, world!'
Chris@0: print $exporter->export('hello, world!');
Chris@0: 
Chris@0: // false
Chris@0: print $exporter->export(false);
Chris@0: 
Chris@0: // NAN
Chris@0: print $exporter->export(acos(8));
Chris@0: 
Chris@0: // -INF
Chris@0: print $exporter->export(log(0));
Chris@0: 
Chris@0: // null
Chris@0: print $exporter->export(null);
Chris@0: 
Chris@0: // resource(13) of type (stream)
Chris@0: print $exporter->export(fopen('php://stderr', 'w'));
Chris@0: 
Chris@0: // Binary String: 0x000102030405
Chris@0: print $exporter->export(chr(0) . chr(1) . chr(2) . chr(3) . chr(4) . chr(5));
Chris@0: ```
Chris@0: 
Chris@0: Exporting complex types:
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: use SebastianBergmann\Exporter\Exporter;
Chris@0: 
Chris@0: $exporter = new Exporter;
Chris@0: 
Chris@0: /*
Chris@0: Array &0 (
Chris@0:     0 => Array &1 (
Chris@0:         0 => 1
Chris@0:         1 => 2
Chris@0:         2 => 3
Chris@0:     )
Chris@0:     1 => Array &2 (
Chris@0:         0 => ''
Chris@0:         1 => 0
Chris@0:         2 => false
Chris@0:     )
Chris@0: )
Chris@0: */
Chris@0: 
Chris@0: print $exporter->export(array(array(1,2,3), array("",0,FALSE)));
Chris@0: 
Chris@0: /*
Chris@0: Array &0 (
Chris@0:     'self' => Array &1 (
Chris@0:         'self' => Array &1
Chris@0:     )
Chris@0: )
Chris@0: */
Chris@0: 
Chris@0: $array = array();
Chris@0: $array['self'] = &$array;
Chris@0: print $exporter->export($array);
Chris@0: 
Chris@0: /*
Chris@0: stdClass Object &0000000003a66dcc0000000025e723e2 (
Chris@0:     'self' => stdClass Object &0000000003a66dcc0000000025e723e2
Chris@0: )
Chris@0: */
Chris@0: 
Chris@0: $obj = new stdClass();
Chris@0: $obj->self = $obj;
Chris@0: print $exporter->export($obj);
Chris@0: ```
Chris@0: 
Chris@0: Compact exports:
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: use SebastianBergmann\Exporter\Exporter;
Chris@0: 
Chris@0: $exporter = new Exporter;
Chris@0: 
Chris@0: // Array ()
Chris@0: print $exporter->shortenedExport(array());
Chris@0: 
Chris@0: // Array (...)
Chris@0: print $exporter->shortenedExport(array(1,2,3,4,5));
Chris@0: 
Chris@0: // stdClass Object ()
Chris@0: print $exporter->shortenedExport(new stdClass);
Chris@0: 
Chris@0: // Exception Object (...)
Chris@0: print $exporter->shortenedExport(new Exception);
Chris@0: 
Chris@0: // this\nis\na\nsuper\nlong\nstring\nt...\nspace
Chris@0: print $exporter->shortenedExport(
Chris@0: <<<LONG_STRING
Chris@0: this
Chris@0: is
Chris@0: a
Chris@0: super
Chris@0: long
Chris@0: string
Chris@0: that
Chris@0: wraps
Chris@0: a
Chris@0: lot
Chris@0: and
Chris@0: eats
Chris@0: up
Chris@0: a
Chris@0: lot
Chris@0: of
Chris@0: space
Chris@0: LONG_STRING
Chris@0: );
Chris@0: ```
Chris@0: 
Chris@0: ## Installation
Chris@0: 
Chris@2: You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
Chris@0: 
Chris@2:     composer require sebastian/exporter
Chris@2: 
Chris@2: If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
Chris@2: 
Chris@2:     composer require --dev sebastian/exporter
Chris@2: