<?php

namespace hisorange\BrowserDetect\Contracts;

interface PayloadInterface
{
    /**
     * Initialize the payload for process.
     *
     * @param string $agent User agent string.
     */
    public function __construct(string $agent);

    /**
     * Each stage can access the user agent through this interface.
     *
     * @return string Original user agent string.
     */
    public function getAgent(): string;

    /**
     * Set a value in the temporary data schema before the next stage.
     *
     * @param string $key   Storage key.
     * @param mixed  $value Stored value.
     */
    public function setValue(string $key, $value): void;

    /**
     * Get a value if exists in the data schema,
     * returns null if the key does not exist.
     *
     * @param string $key Temporary data key.
     *
     * @return mixed
     */
    public function getValue(string $key);

    /**
     * Immutable accessor to the internal data collection.
     *
     * @return array
     */
    public function toArray(): array;
}