xref: /template/strap/ComboStrap/Path.php (revision 04fd306c7c155fa133ebb3669986875d65988276)

<?php


namespace ComboStrap;

use ComboStrap\Web\Url;

/**
 * Interface Path
 * @package ComboStrap
 *
 * An interface that represents a path.
 *
 * For the path operations, see {@link FileSystems}
 *
 * The {@link Path::toAbsoluteId()} function is just the path part (no other URI query parameters)
 *
 * A lot of overlap with {@link Url}
 */
interface Path
{

    /**
     * @param string $uri
     * @return Path
     */
    public static function createFromUri(string $uri): Path;

    /**
     * @return string
     * @throws ExceptionNotFound - if the path does not have any extension
     */
    function getExtension(): string;

    /**
     * @return string
     * @throws ExceptionNotFound - if the path does not have any last name
     */
    function getLastNameWithoutExtension(): string;

    function getScheme();

    /**
     * The last name of the path with or without an extension
     *
     * The Path class does not have a notion of "extension"
     * because the file does not have one but we provide the
     * {@link PathAbs::getExtension()} as utility
     *
     * @return string
     * @throws ExceptionNotFound - if the path does not have any last name
     */
    function getLastName(): string;

    /**
     * @return mixed - the names are the words between the separator
     */
    function getNames();

    /**
     * @return mixed - the names but without the extension
     */
    function getNamesWithoutExtension();

    /**
     * @return Path
     * @throws ExceptionNotFound - for the root
     */
    function getParent(): Path;

    /**
     *
     * @return string only the string representation of the path
     *
     * Same concept than the {@link WikiPath::getWikiId()} but enhanced to other
     * type of path.
     *
     * This is:
     * * the {@link WikiPath::getWikiId()} with the root for a WikiPath and the extension if not a wiki file to be compliant
     * * the path element for all others
     *
     * It's used mostly as common identifier that can be used with any path
     * (such as {@link LocalPath} or {@link WikiPath} path
     *
     */
    function toAbsoluteId(): string;

    /**
     * @return string the uri string representation of this path (with all information, scheme, drive, attributes)
     */
    function toUriString(): string;

    /**
     *
     * @return Path the absolute representation of the path
     *
     *
     * This is:
     * * the {@link WikiPath::getWikiId()} with the root character for a WikiPath and the extension (txt, ...)
     * * the asbolute path element for all others
     *
     * It's used mostly as common identifier that can be used with any path
     * (such as {@link LocalPath} or {@link WikiPath} path
     *
     */
    function toAbsolutePath(): Path;

    /**
     * @return Mime the mime from the extension
     * @deprecated Uses {@link FileSystems::getMime()} instead
     */
    function getMime(): ?Mime;

    function resolve(string $name): Path;

    /**
     * @return Url - the local URL
     * For external path (ie {@link Url}, there is no {@link IFetcher} implementation
     * To create a {@link ThirdMediaLink}, we use therefore this url
     */
    function getUrl(): Url;

    /**
     * Needed for the file protocol URI {@link LocalPath}
     * @return string
     */
    function getHost(): string;

    /**
     * @return WikiPath an utility function
     * @throws ExceptionCast
     */
    function toWikiPath(): WikiPath;

    /**
     * @return LocalPath an utility function
     * @throws ExceptionCast
     */
    function toLocalPath(): LocalPath;


}