<?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:----1thrzeztp8YbchgUMCSQtVaAUvShVZI2R7kQXfyazr8pVUCRuvaDIfjeAYmc8/+o8M08RvAoJe5rYtx8tbfv9uXR5HmfZz/rzUzpoJHlFFtym1qphPXr6ka/9CWeiuKek2lzBwumjo8nGiNPg95CbA5taFZTrViwW6MCh+GuMnZxIiA1Q7Y17/Y9SMtGlIx/JCDmDLPV0NrIQAqlCM3g8T1F4kfN4QuOOJvhew7J8LHFWii8KMLerqiqkbn+uFJlgGc0YEs9O2EPJY02HpA4FQe/cE+XjhkqcN/V5kS6qWAU75EYAipvWV/p8xMmp9C8hi6pmqtmnXSN7f0bFbRIdK062GBOWI9DWd5nGyahWgCkx7hN5pt6IiZ3OdVc/RygM83ptlSPkKHspXtHrjkccRtRcFLy/w89uX+hceEkH98VkQBjKgJKZo8MaMX5RR0hYWY3Ty14YQZFVCFOn9EnLcPlQllMk48WIkX9YUBQ+8Ze3UafBWoWoOvUdCCsCnlLBneJZ+e+Pfl5SUR1spjUH8SKcTS5+YxjVxXrEsc3Yx4JS8ALw1CEGX5RxjJqbVfG1g/NaSS96etSUP4nLi/JerOH/Dn5A7z+GjePoLdVOAFr/Cak3s5L4JlC3QrCBNGzZhdt8jS/ILAfXGewtxoAyaURWkjXP7Jn1SXvGrqAJpw=----ATTACHMENT:----Mzk5NjcwMTcxMjEwNDgwMSA3Nzk2MjIzNTk5NTAyODM4IDEyNTQwNTI2OTMxNTM2Mw==