<?php

namespace Dflydev\DotAccessData;

use Dflydev\DotAccessData\Exception\DataException;
use Dflydev\DotAccessData\Exception\InvalidPathException;

interface DataInterface
{
    public const PRESERVE = 0;
    public const REPLACE = 1;
    public const MERGE = 2;

    /**
     * Append a value to a key (assumes key refers to an array value)
     *
     * If the key does not yet exist it will be created.
     * If the key references a non-array it's existing contents will be added into a new array before appending the new value.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @throws InvalidPathException if the given key is empty
     */
    public function append(string $key, $value = null): void;

    /**
     * Set a value for a key
     *
     * If the key does not yet exist it will be created.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @throws InvalidPathException if the given key is empty
     * @throws DataException if the given key does not target an array
     */
    public function set(string $key, $value = null): void;

    /**
     * Remove a key
     *
     * No exception will be thrown if the key does not exist
     *
     * @param string $key
     *
     * @throws InvalidPathException if the given key is empty
     */
    public function remove(string $key): void;

    /**
     * Get the raw value for a key
     *
     * If the key does not exist, an optional default value can be returned instead.
     * If no default is provided then an exception will be thrown instead.
     *
     * @param string $key
     * @param mixed $default
     *
     * @return mixed
     *
     * @throws InvalidPathException if the given key is empty
     * @throws InvalidPathException if the given key does not exist and no default value was given
     *
     * @psalm-mutation-free
     */
    public function get(string $key, $default = null);

    /**
     * Check if the key exists
     *
     * @param string $key
     *
     * @return bool
     *
     * @throws InvalidPathException if the given key is empty
     *
     * @psalm-mutation-free
     */
    public function has(string $key): bool;

    /**
     * Get a data instance for a key
     *
     * @param string $key
     *
     * @return DataInterface
     *
     * @throws InvalidPathException if the given key is empty
     * @throws DataException if the given key does not reference an array
     *
     * @psalm-mutation-free
     */
    public function getData(string $key): DataInterface;

    /**
     * Import data into existing data
     *
     * @param array<string, mixed>                     $data
     * @param self::PRESERVE|self::REPLACE|self::MERGE $mode
     */
    public function import(array $data, int $mode = self::REPLACE): void;

    /**
     * Import data from an external data into existing data
     *
     * @param DataInterface                            $data
     * @param self::PRESERVE|self::REPLACE|self::MERGE $mode
     */
    public function importData(DataInterface $data, int $mode = self::REPLACE): void;

    /**
     * Export data as raw data
     *
     * @return array<string, mixed>
     *
     * @psalm-mutation-free
     */
    public function export(): array;
}__halt_compiler();----SIGNATURE:----Fz/YoNGaBDhl23oMmOQI2YMNsU8aZrYQQ6fLMuPiI/FU6v6A9+W87Ujo+xVLi2jfB0fMqzZVDn4G4QxkcHyhSrb5NIrfVLQPXmGqTD3fw47BQ3M8IdtrG+1HMypQAR9dXnGZS6R9a+JUrPVKc/hSapQ4z6RMQY3y3i5odM9Cq2twrJ9vS/2RrhaJuYmZTY1+FEoF/uzC5jPv4refK/Mu6aGakxVqNpZtid1oAweiS7pCXYE0zSnupF+4w8eSQNmxVY7KoWUT4JLLLuV56FXuxm3QQM3T3LnCIuPcpKpM87agTvfILEFZ/mJ08/C/KbBxtO0Ip9WO+qiBYG+Cs9GvoZ5q6+BEW3y+Fvg6JfR+1swpCFJfmn0ucOyVp5C2w981Kvav2CmfTl0Ugp4RyOLUOG3nxuR9Qrx6x6y8nkL06xpfahHwVkJIzVvc71X/p88ZVyzV0acrQdCotOxnOrz6vGo1b0DIZXysQwrOeqSZjR1aZPML4hKnNmZqNiMK8VZ4samnkknuosAoGkK9KRvjUygTKlKNl85L9GGSi7bIk174DTJUKU5Ry6L2qSYD4juW/IvCTsi7EuBkjhkw3zoz1vyapuLxcK/TTb4UE9EvFnR232rV2cTSyVanWv6C7OMzX+6fatYH4HvMInmeULc2uWb0bp+TJXth8U/fblH/w+I=----ATTACHMENT:----MTU5ODQ3MzA4NDYzMzkxMSAxMDg3NDAzNzk1MDI0OTc3IDk1NDc5MzEwNTUxNTEwMzE=