vendor/jacquesbh/eater/src/EaterInterface.php line 47

Open in your IDE?
  1. <?php
  3. namespace Jacquesbh\Eater;
  5. use ArrayAccess;
  6. use Countable;
  7. use Iterator;
  8. use IteratorAggregate;
  9. use JsonSerializable;
  11. interface EaterInterface extends ArrayAccess, IteratorAggregate, JsonSerializable, Countable
  12. {
  13.     /**
  14.      * @param array|EaterInterface|null $data
  15.      *
  16.      * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
  17.      */
  18.     public function addData($data, bool $recursive = false): self;
  20.     /**
  21.      * @param mixed $name
  22.      * @param mixed $value
  23.      *
  24.      * @SuppressWarnings(PHPMD.BooleanArgumentFlag)
  25.      */
  26.     public function setData($name = null, $value = null, bool $recursive = false): self;
  28.     /**
  29.      * @return mixed
  30.      */
  31.     public function getData(string $name = null, string $field = null);
  33.     public function hasData(string $name = null): bool;
  35.     public function unsetData(string $name = null): self;
  37.     /**
  38.      * @param mixed $offset
  39.      */
  40.     public function offsetExists($offset): bool;
  42.     /**
  43.      * @param mixed $offset
  44.      *
  45.      * @return mixed
  46.      */
  47.     public function offsetGet($offset);
  49.     /**
  50.      * @param mixed $offset
  51.      * @param mixed $value
  52.      */
  53.     public function offsetSet($offset, $value): void;
  55.     /**
  56.      * @param mixed $offset
  57.      */
  58.     public function offsetUnset($offset): void;
  60.     /**
  61.      * Format a string for storage
  62.      */
  63.     public function format(string $str): string;
  65.     /**
  66.      * Merge an other Eater (or array)
  67.      *
  68.      * @param EaterInterface|array $eater
  69.      */
  70.     public function merge($eater): self;
  72.     /**
  73.      * Retrun a new external Iterator, used internally for foreach loops.
  74.      */
  75.     public function getIterator(): Iterator;
  77.     /**
  78.      * Retrun the number of datas contained in the current Eater object.
  79.      * This does not include datas contained by child Eater instances.
  80.      */
  81.     public function count(): int;
  82. }