www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/var-dumper/Cloner/DumperInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\VarDumper\Cloner;
  13
  14 /**
  15  * DumperInterface used by Data objects.
  16  *
  17  * @author Nicolas Grekas <p@tchwork.com>
  18  */
  19 interface DumperInterface
  20 {
  21     /**
  22      * Dumps a scalar value.
  23      *
  24      * @param Cursor                $cursor The Cursor position in the dump
  25      * @param string                $type   The PHP type of the value being dumped
  26      * @param string|int|float|bool $value  The scalar value being dumped
  27      */
  28     public function dumpScalar(Cursor $cursor, $type, $value);
  29
  30     /**
  31      * Dumps a string.
  32      *
  33      * @param Cursor $cursor The Cursor position in the dump
  34      * @param string $str    The string being dumped
  35      * @param bool   $bin    Whether $str is UTF-8 or binary encoded
  36      * @param int    $cut    The number of characters $str has been cut by
  37      */
  38     public function dumpString(Cursor $cursor, $str, $bin, $cut);
  39
  40     /**
  41      * Dumps while entering an hash.
  42      *
  43      * @param Cursor $cursor   The Cursor position in the dump
  44      * @param int    $type     A Cursor::HASH_* const for the type of hash
  45      * @param string $class    The object class, resource type or array count
  46      * @param bool   $hasChild When the dump of the hash has child item
  47      */
  48     public function enterHash(Cursor $cursor, $type, $class, $hasChild);
  49
  50     /**
  51      * Dumps while leaving an hash.
  52      *
  53      * @param Cursor $cursor   The Cursor position in the dump
  54      * @param int    $type     A Cursor::HASH_* const for the type of hash
  55      * @param string $class    The object class, resource type or array count
  56      * @param bool   $hasChild When the dump of the hash has child item
  57      * @param int    $cut      The number of items the hash has been cut by
  58      */
  59     public function leaveHash(Cursor $cursor, $type, $class, $hasChild, $cut);
  60 }