Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\VarDumper;
Chris@13: 
Chris@13: use Symfony\Component\Console\Formatter\OutputFormatter;
Chris@13: use Symfony\Component\VarDumper\Caster\Caster;
Chris@13: use Symfony\Component\VarDumper\Cloner\Stub;
Chris@13: 
Chris@13: /**
Chris@13:  * A Presenter service.
Chris@13:  */
Chris@13: class Presenter
Chris@13: {
Chris@13:     const VERBOSE = 1;
Chris@13: 
Chris@13:     private $cloner;
Chris@13:     private $dumper;
Chris@13:     private $exceptionsImportants = [
Chris@13:         "\0*\0message",
Chris@13:         "\0*\0code",
Chris@13:         "\0*\0file",
Chris@13:         "\0*\0line",
Chris@13:         "\0Exception\0previous",
Chris@13:     ];
Chris@13:     private $styles = [
Chris@13:         'num'       => 'number',
Chris@13:         'const'     => 'const',
Chris@13:         'str'       => 'string',
Chris@13:         'cchr'      => 'default',
Chris@13:         'note'      => 'class',
Chris@13:         'ref'       => 'default',
Chris@13:         'public'    => 'public',
Chris@13:         'protected' => 'protected',
Chris@13:         'private'   => 'private',
Chris@13:         'meta'      => 'comment',
Chris@13:         'key'       => 'comment',
Chris@13:         'index'     => 'number',
Chris@13:     ];
Chris@13: 
Chris@13:     public function __construct(OutputFormatter $formatter, $forceArrayIndexes = false)
Chris@13:     {
Chris@13:         // Work around https://github.com/symfony/symfony/issues/23572
Chris@17:         $oldLocale = \setlocale(LC_NUMERIC, 0);
Chris@17:         \setlocale(LC_NUMERIC, 'C');
Chris@13: 
Chris@13:         $this->dumper = new Dumper($formatter, $forceArrayIndexes);
Chris@13:         $this->dumper->setStyles($this->styles);
Chris@13: 
Chris@13:         // Now put the locale back
Chris@17:         \setlocale(LC_NUMERIC, $oldLocale);
Chris@13: 
Chris@13:         $this->cloner = new Cloner();
Chris@13:         $this->cloner->addCasters(['*' => function ($obj, array $a, Stub $stub, $isNested, $filter = 0) {
Chris@13:             if ($filter || $isNested) {
Chris@13:                 if ($obj instanceof \Exception) {
Chris@13:                     $a = Caster::filter($a, Caster::EXCLUDE_NOT_IMPORTANT | Caster::EXCLUDE_EMPTY, $this->exceptionsImportants);
Chris@13:                 } else {
Chris@13:                     $a = Caster::filter($a, Caster::EXCLUDE_PROTECTED | Caster::EXCLUDE_PRIVATE);
Chris@13:                 }
Chris@13:             }
Chris@13: 
Chris@13:             return $a;
Chris@13:         }]);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Register casters.
Chris@13:      *
Chris@13:      * @see http://symfony.com/doc/current/components/var_dumper/advanced.html#casters
Chris@13:      *
Chris@13:      * @param callable[] $casters A map of casters
Chris@13:      */
Chris@13:     public function addCasters(array $casters)
Chris@13:     {
Chris@13:         $this->cloner->addCasters($casters);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Present a reference to the value.
Chris@13:      *
Chris@13:      * @param mixed $value
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     public function presentRef($value)
Chris@13:     {
Chris@13:         return $this->present($value, 0);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Present a full representation of the value.
Chris@13:      *
Chris@13:      * If $depth is 0, the value will be presented as a ref instead.
Chris@13:      *
Chris@13:      * @param mixed $value
Chris@13:      * @param int   $depth   (default: null)
Chris@13:      * @param int   $options One of Presenter constants
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     public function present($value, $depth = null, $options = 0)
Chris@13:     {
Chris@13:         $data = $this->cloner->cloneVar($value, !($options & self::VERBOSE) ? Caster::EXCLUDE_VERBOSE : 0);
Chris@13: 
Chris@13:         if (null !== $depth) {
Chris@13:             $data = $data->withMaxDepth($depth);
Chris@13:         }
Chris@13: 
Chris@13:         // Work around https://github.com/symfony/symfony/issues/23572
Chris@17:         $oldLocale = \setlocale(LC_NUMERIC, 0);
Chris@17:         \setlocale(LC_NUMERIC, 'C');
Chris@13: 
Chris@13:         $output = '';
Chris@13:         $this->dumper->dump($data, function ($line, $depth) use (&$output) {
Chris@13:             if ($depth >= 0) {
Chris@13:                 if ('' !== $output) {
Chris@13:                     $output .= PHP_EOL;
Chris@13:                 }
Chris@17:                 $output .= \str_repeat('  ', $depth) . $line;
Chris@13:             }
Chris@13:         });
Chris@13: 
Chris@13:         // Now put the locale back
Chris@17:         \setlocale(LC_NUMERIC, $oldLocale);
Chris@13: 
Chris@13:         return OutputFormatter::escape($output);
Chris@13:     }
Chris@13: }