darling/php-file-system-paths

Defines classes for working with a file system in php.

v1.0.0 2023-12-07 22:50 UTC

Requires

• php: ^8.1
• darling/php-darling-dev-tools: ^1.0
• darling/php-text-types: ^1.1
• darling/php-unit-test-utilities: ^1.0

Requires (Dev)

• phpstan/phpstan: *
• phpunit/phpunit: *

MIT

• sevidmusic

README

The PHPFileSystemPaths defines classes for working with file system paths in php.

\Darling\PHPFileSystemPaths\classes\paths\PathToExistingDirectory

A PathToExisitingDirectory can be used when a path to an existing directory is required.

The __toString() method can be used to obtain the path to the directory.

If the assigned SafeTextCollection can be mapped to an existing directory it will be used to construct the path returned by the __toString() method.

However, if the assigned SafeTextCollection cannot be mapped to an existing directory then the __toString() method will return the path returned by php's sys_get_temp_dir() function.

Methods:

    /**
     * Return the SafeTextCollection that defines the parts of this
     * PathToExistingDirectory.
     *
     * @return SafeTextCollection
     *
     */
    public function safeTextCollection(): SafeTextCollection;


    /**
     * Return the path to the existing directory.
     *
     * @return string
     *
     */
    public function __toString(): string;

\Darling\PHPFileSystemPaths\classes\paths\PathToExistingFile

A PathToExistingFile can be used when a path to an existing file is required.

The __toString() method can be used to obtain the path to the file.

If the assigned PathToExistingDirectory and Name can be mapped to an existing file they will be used to construct the path returned by the __toString() method.

However, if the assigned PathToExistingDirectory and Name cannot be mapped to an existing file then the __toString() method will return the path to a temporary file in the directory whose path matches the path returned by php's sys_get_temp_dir() function.

The temporary file name will always be : PHPFileSystemPathsEmptyTmpFile

The temporary file will be created if necessary.

Methods:

    /**
     * Return the PathToExisitingDirectory that defines the path where
     * the file is expected to be located.
     *
     * @return PathToExistingDirectory
     *
     */
    public function pathToExistingDirectory(): PathToExistingDirectory;

    /**
     * Return the Name of the file.
     *
     * @return Name
     *
     */
    public function name(): Name;


    /**
     * Return the path to the file.
     *
     * @return string
     *
     */
    public function __toString(): string;