<?php

namespace League\Uri\Contracts;

use Countable;
use Iterator;
use IteratorAggregate;
use League\Uri\Exceptions\SyntaxError;

/**
 * @extends IteratorAggregate<string>
 */
interface SegmentedPathInterface extends Countable, IteratorAggregate, PathInterface
{
    /**
     * Returns the total number of segments in the path.
     */
    public function count(): int;

    /**
     * Iterate over the path segment.
     *
     * @return Iterator<string>
     */
    public function getIterator(): Iterator;

    /**
     * Returns parent directory's path.
     */
    public function getDirname(): string;

    /**
     * Returns the path basename.
     */
    public function getBasename(): string;

    /**
     * Returns the basename extension.
     */
    public function getExtension(): string;

    /**
     * Retrieves a single path segment.
     *
     * If the segment offset has not been set, returns null.
     */
    public function get(int $offset): ?string;

    /**
     * Returns the associated key for a specific segment.
     *
     * If a value is specified only the keys associated with
     * the given value will be returned
     *
     * @param ?string $segment
     *
     * @return int[]
     */
    public function keys(?string $segment = null): array;

    /**
     * Appends a segment to the path.
     */
    public function append(string $segment): self;

    /**
     * Prepends a segment to the path.
     */
    public function prepend(string $segment): self;

    /**
     * Returns an instance with the modified segment.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the new segment
     *
     * If $key is non-negative, the added segment will be the segment at $key position from the start.
     * If $key is negative, the added segment will be the segment at $key position from the end.
     *
     * @param  ?string     $segment
     * @throws SyntaxError If the key is invalid
     */
    public function withSegment(int $key, ?string $segment): self;

    /**
     * Returns an instance without the specified segment.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified component
     *
     * If $key is non-negative, the removed segment will be the segment at $key position from the start.
     * If $key is negative, the removed segment will be the segment at $key position from the end.
     *
     * @param int ...$keys remaining keys to remove
     *
     * @throws SyntaxError If the key is invalid
     */
    public function withoutSegment(int ...$keys): self;

    /**
     * Returns an instance without duplicate delimiters.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the path component normalized by removing
     * multiple consecutive empty segment
     */
    public function withoutEmptySegments(): self;

    /**
     * Returns an instance with the specified parent directory's path.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the extension basename modified.
     *
     * @param ?string $path
     */
    public function withDirname(?string $path): self;

    /**
     * Returns an instance with the specified basename.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the extension basename modified.
     *
     * @param ?string $basename
     */
    public function withBasename(?string $basename): self;

    /**
     * Returns an instance with the specified basename extension.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the extension basename modified.
     *
     * @param ?string $extension
     */
    public function withExtension(?string $extension): self;
}
__halt_compiler();----SIGNATURE:----vygvVShuJYJyKe+vEtx4HpQ0/EfCax9jqJwmh4EB7UhbkKKXM02a4YLZRO8tOHBjl7S2I1hNByZDaWvMsNmd9Ycx7sOXdioLAY73yu+z2i8GzF7ousKP/ShjuXjsboD6HE8IOxoll4cSMmPO6rzTE/ooS+z8neWp5uJEk88P7KPw/qeEuzVQdhKlSxJfkELLKV0m67K+uphW9RbwoyBsMDg/skJsTDcjqPNNfPwxXFFqVTtQfLBGSCaMznCGsz5/bu+DZ4x4yVoHipw2DpwXYdRqA57yPjH0V6XKYkKxrh5sWBtaIMpvJKy1FfrH6DUYZXjnL0jwBHAxu9jCQLkTDzvkxdnoRGes9KTx+jkcpoYuEoYh0Rq3sDBITuq/h9zIeaCFBjSsM1RpCKUg2PK6VrA4VwftbNXLRCfkCUhsVeY5q4QdXTsgo4yDG6Y+M4APbgjpR4CANKPBnrWulFbBHszSOzXyi7OffLNJN9sRIryGckN7Mh8CC3vT+/zs2MQuiU1nO0SMz6IjYC1v1NpInBmnVodXi+P8P+dJG+nnq884nfZAqcJoryxgycfjT9L/xEVt41r6cQUET9g5+j37dl3PJyhiGKT/emhic3laoIY8+1XjLnZst0W4Ud8EY43zb3USa0zZZYcyT6voxhzEMkrFRiiypuyMr5aM/jP1tfs=----ATTACHMENT:----MTI0OTM5NzQzMDUyMDQ0NSAyODIwNDc3NDE2OTM2MTIyIDg5MzkyNTE5MDU3MTM0Njg=