eloquent/pathogen API
Class

Eloquent\Pathogen\Windows\WindowsPath

abstract class WindowsPath extends Path

A static utility class for constructing Windows paths.

Do not use this class in type hints; use WindowsPathInterface instead.

Methods

static PathInterface fromString(string $path)

Creates a new path instance from its string representation.

 from Path
static PathInterface fromAtoms(mixed<string> $atoms, boolean|null $isAbsolute = null, boolean|null $hasTrailingSeparator = null)

Creates a new path instance from a set of path atoms.

 from Path
static WindowsPathInterface fromDriveAndAtoms(mixed<string> $atoms, string|null $drive = null, boolean|null $isAbsolute = null, boolean|null $isAnchored = null, boolean|null $hasTrailingSeparator = null)

Creates a new path instance from a set of path atoms and a drive specifier.

Details

in Path at line 28
static public PathInterface fromString(string $path)

Creates a new path instance from its string representation.

Parameters

string $path The string representation of the path.

Return Value

PathInterface The newly created path instance.

in Path at line 43
static public PathInterface fromAtoms(mixed<string> $atoms, boolean|null $isAbsolute = null, boolean|null $hasTrailingSeparator = null)

Creates a new path instance from a set of path atoms.

Parameters

mixed<string> $atoms The path atoms.
boolean|null $isAbsolute True if the path is absolute.
boolean|null $hasTrailingSeparator True if the path has a trailing separator.

Return Value

PathInterface The newly created path instance.

Exceptions

InvalidPathAtomExceptionInterface If any of the supplied atoms are invalid.

at line 37
static public WindowsPathInterface fromDriveAndAtoms(mixed<string> $atoms, string|null $drive = null, boolean|null $isAbsolute = null, boolean|null $isAnchored = null, boolean|null $hasTrailingSeparator = null)

Creates a new path instance from a set of path atoms and a drive specifier.

Parameters

mixed<string> $atoms The path atoms.
string|null $drive The drive specifier.
boolean|null $isAbsolute True if the path is absolute.
boolean|null $isAnchored True if the path is anchored to the drive root.
boolean|null $hasTrailingSeparator True if the path has a trailing separator.

Return Value

WindowsPathInterface The newly created path instance.

Exceptions

InvalidPathAtomExceptionInterface If any of the supplied atoms are invalid.