xref: /plugin/combo/ComboStrap/Path.php (revision 4cadd4f8c541149bdda95f080e38a6d4e3a640ca)

<?php


namespace ComboStrap;

/**
 * Interface Path
 * @package ComboStrap
 *
 * An interface that implements path operation
 *
 * The {@link Path::toString()} function is just the path part (no other URI query parameters)
 *
 * TODO: because a path should be able to go to an URI format, it should also allow query parameters
 *  We could then add a `toPath` function to {@link DokuwikiUrl} and delete the tag attributes
 *  as parameter of all {@link MediaLink::createMediaLinkFromPath()} creator function
 */
interface Path
{

    function getExtension();

    function getLastNameWithoutExtension();

    function getScheme();

    /**
     * The last name of the path with or without the 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 mixed
     */
    function getLastName();

    function getNames();

    function getParent(): ?Path;

    /**
     * @return string only the string representation of the path
     */
    function toString(): string;

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

    function toAbsolutePath(): Path;

    /**
     * @return Mime the mime from the extension
     */
    function getMime(): ?Mime;

    function resolve(string $name);

    /**
     * @return DokuPath
     * @throws ExceptionCombo - if the path cannot be transformed to a doku path
     */
    function toDokuPath(): DokuPath;
}