eloquent/pathogen API
Interface

Eloquent\Pathogen\FileSystem\AbsoluteFileSystemPathInterface

interface AbsoluteFileSystemPathInterface implements AbsolutePathInterface, FileSystemPathInterface

The interface implemented by absolute file system paths.

Methods

boolean isRoot()

Determine whether this path is the root path.

 from AbsolutePathInterface
boolean isParentOf(AbsolutePathInterface $path)

Determine if this path is the direct parent of the supplied path.

 from AbsolutePathInterface
boolean isAncestorOf(AbsolutePathInterface $path)

Determine if this path is an ancestor of the supplied path.

 from AbsolutePathInterface
RelativePathInterface relativeTo(AbsolutePathInterface $path)

Determine the shortest path from the supplied path to this path.

 from AbsolutePathInterface
AbsolutePathInterface resolve(PathInterface $path)

Resolve the supplied path against this path.

 from AbsolutePathInterface

Details

in AbsolutePathInterface at line 26
public boolean isRoot()

Determine whether this path is the root path.

The root path is an absolute path with no atoms.

Return Value

boolean True if this path is the root path.

in AbsolutePathInterface at line 35
public boolean isParentOf(AbsolutePathInterface $path)

Determine if this path is the direct parent of the supplied path.

Parameters

AbsolutePathInterface $path The child path.

Return Value

boolean True if this path is the direct parent of the supplied path.

in AbsolutePathInterface at line 44
public boolean isAncestorOf(AbsolutePathInterface $path)

Determine if this path is an ancestor of the supplied path.

Parameters

AbsolutePathInterface $path The child path.

Return Value

boolean True if this path is an ancestor of the supplied path.

in AbsolutePathInterface at line 56
public RelativePathInterface relativeTo(AbsolutePathInterface $path)

Determine the shortest path from the supplied path to this path.

For example, given path A equal to '/foo/bar', and path B equal to '/foo/baz', A relative to B would be '../bar'.

Parameters

AbsolutePathInterface $path The path that the generated path will be relative to.

Return Value

RelativePathInterface A relative path from the supplied path to this path.

in AbsolutePathInterface at line 65
public AbsolutePathInterface resolve(PathInterface $path)

Resolve the supplied path against this path.

Parameters

PathInterface $path The path to resolve.

Return Value

AbsolutePathInterface The resolved path.