Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\VarDumper\Cloner;
Chris@0: 
Chris@0: /**
Chris@0:  * DumperInterface used by Data objects.
Chris@0:  *
Chris@0:  * @author Nicolas Grekas <p@tchwork.com>
Chris@0:  */
Chris@0: interface DumperInterface
Chris@0: {
Chris@0:     /**
Chris@0:      * Dumps a scalar value.
Chris@0:      *
Chris@12:      * @param Cursor                $cursor The Cursor position in the dump
Chris@12:      * @param string                $type   The PHP type of the value being dumped
Chris@12:      * @param string|int|float|bool $value  The scalar value being dumped
Chris@0:      */
Chris@0:     public function dumpScalar(Cursor $cursor, $type, $value);
Chris@0: 
Chris@0:     /**
Chris@0:      * Dumps a string.
Chris@0:      *
Chris@0:      * @param Cursor $cursor The Cursor position in the dump
Chris@0:      * @param string $str    The string being dumped
Chris@0:      * @param bool   $bin    Whether $str is UTF-8 or binary encoded
Chris@0:      * @param int    $cut    The number of characters $str has been cut by
Chris@0:      */
Chris@0:     public function dumpString(Cursor $cursor, $str, $bin, $cut);
Chris@0: 
Chris@0:     /**
Chris@0:      * Dumps while entering an hash.
Chris@0:      *
Chris@0:      * @param Cursor $cursor   The Cursor position in the dump
Chris@0:      * @param int    $type     A Cursor::HASH_* const for the type of hash
Chris@0:      * @param string $class    The object class, resource type or array count
Chris@0:      * @param bool   $hasChild When the dump of the hash has child item
Chris@0:      */
Chris@0:     public function enterHash(Cursor $cursor, $type, $class, $hasChild);
Chris@0: 
Chris@0:     /**
Chris@0:      * Dumps while leaving an hash.
Chris@0:      *
Chris@0:      * @param Cursor $cursor   The Cursor position in the dump
Chris@0:      * @param int    $type     A Cursor::HASH_* const for the type of hash
Chris@0:      * @param string $class    The object class, resource type or array count
Chris@0:      * @param bool   $hasChild When the dump of the hash has child item
Chris@0:      * @param int    $cut      The number of items the hash has been cut by
Chris@0:      */
Chris@0:     public function leaveHash(Cursor $cursor, $type, $class, $hasChild, $cut);
Chris@0: }