\phpDocumentorPath

Value Object for paths.

This can be absolute or relative.

Summary

Methods
Properties
Constants
__construct()
equals()
__toString()
isAbsolutePath()
dirname()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$path
N/A

Properties

$path

$path : string

Type

string

Methods

__construct()

__construct(string  $path) : mixed

Initializes the path.

Parameters

string $path

Returns

mixed —

equals()

equals(self  $otherPath) : bool

Verifies if another Path object has the same identity as this one.

Parameters

self $otherPath

Returns

bool —

__toString()

__toString() : string

returns a string representation of the path.

Returns

string —

isAbsolutePath()

isAbsolutePath(string  $file) : bool

Returns whether the file path is an absolute path.

Parameters

string $file

A file path

Returns

bool —

dirname()

dirname(\phpDocumentor\Path  $input) : self

Parameters

\phpDocumentor\Path $input

Returns

self —