<?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:----Pab95JFMR6BtKBJHmISLF8v43HCecdewWqN2q3QsuQnTegywck8wxMUc+9yS3hZCyxegVU9++hlbBxPleI2TDY2XkiC6w3QVm+ZASYuf8fa96JXQO4Coo2isjMjW5PCYMgCaPEreht0ktWTjVKmYPwkfc7o/0QNd+nQYRyG6vEcz+KtcEBYKw8Md2AcNIug/mOQGeYt/rShyOnKSpKUf6VJ7fDsjYSf8eugvGZJWiass+Cyrzr0CkCEouEBDV6cqZW5BZAbJcliSsoSUWXT3XJc7TjR9EP2JYVDDCbIGNTAbvxKiGsta6OJ1zhc+j8JEPntZmOnKbDndEjS1eubGBaYyqmWWzYJSh3fsX+oPcsba01q+mr6WeIiYUs7VDY4eYlUS92QXKEPm3jT2+BcQXcijujtodANUcpbrQmGOOfhLIAqGTiL07hk1xTVdJU24HvHwL+Gk5lDIlJ2gDPAcNrw+/BZBBXVbx3dd1RCv6Bx1b742b+PnqRVWhZtsZYO+bofNKnAaKraOjiEPbqmEFahNW7TMT3nRqb4fKW8S2dSE8LzejfANNrrR6WZLHH5CYHZQoCt9OGhMuhdvWKwn9GWlwEz9X65YK9VuW+2WXfXArkroJ9GHESEmiy09DZD0LICfx6h7+2aKZYGF7vhiIuJZ2KVj/97C40M7+ptFnUs=----ATTACHMENT:----ODU0NzA0ODYzNDIzMDIxMSA0NDUyMDIzMzYwMzI0OTQ1IDQ3NTA2ODk2MDIwMTI3Mzc=