<?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:----JOb/jkB8dhR8d99wiO489HXb3fjO/R+74lwW/d0A3DZ7E6T9Fyum799fjWDhaxQH1Qsle82SUkK5NRNYCenRpKhe19ldcep+3sWzjePz16h9OzhaZi2qcuTM/2Spbawk8keKuVhh7xhdVjvvQKb1Ag9KhEnrS/d5qn+zauBMRXkGqpewrML9XqNzPLhba5yoQdb5iRN9FVU60rQIwlGEuXUst6/VUABjFxTDJ4zqVc7KokPFn0VsfnhRo1RLRMsjvEBAcF4Iw06Vm8rd99hpe4QTr6iZX60Jc+vzh4tDg+5+lzyfqjMSK+oEuYZRdCITzACy2TWtttztin3UWfcBDtGkDmLvLZzzM9ETsQQz0Y9s4DiNXQiUXE3N9DevR6GGuuVA4liRfe+tKMaEFb4wL4qBljUQuvuMhPSLizLRSFWJoSTx9Qxlsu3LayqZtgnDM5PTJzUaKfZt2SzEC17Ag/YG6P50y/nGSm9SMgjUdol5W/F9CdCIMCcz9cslO1K0+H24WemgwSp3aV7i4LxOdmhahtKnNqoinsmJ/sBD3PwWU9XVA3qgMKUhVLeyHIlHJ1VMQQnXusObfgg3ZNqM9/fhs7Q085KhOtpjpp5tSKerlWEZNZ185v92BepLgScohZQ9kFNpqTOOnlefGO+UyBeiWsHGNNz82vg66iIRm7c=----ATTACHMENT:----MjM5NTI3NzEyMzU3OTU2MCA0MjYyNTY3NDkwNjI1OTk1IDc3ODA5MDY4OTcyNjQ0NjM=