eloquent/pathogen API
Interface

Eloquent\Pathogen\Windows\Factory\WindowsPathFactoryInterface

interface WindowsPathFactoryInterface implements PathFactoryInterface

The interface implemented by path factories that create Windows paths.

Methods

PathInterface create(string $path)

Creates a new path instance from its string representation.

 from PathFactoryInterface
PathInterface createFromAtoms(mixed<string> $atoms, boolean|null $isAbsolute = null, boolean|null $hasTrailingSeparator = null)

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

 from PathFactoryInterface
WindowsPathInterface createFromDriveAndAtoms(mixed<string> $atoms, string|null $drive, 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 PathFactoryInterface at line 30
public PathInterface create(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 PathFactoryInterface at line 43
public PathInterface createFromAtoms(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.
InvalidPathStateException If the supplied arguments would produce an invalid path.

at line 37
public WindowsPathInterface createFromDriveAndAtoms(mixed<string> $atoms, string|null $drive, 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.
InvalidPathStateException If the supplied arguments would produce an invalid path.