PathInterface
extends
UriComponentInterface
in
Table of Contents
- __toString() : string
- Returns the instance string representation.
- decoded() : string
- Returns the decoded path.
- getContent() : string|null
- Returns the instance content.
- getUriComponent() : string
- Returns the instance string representation with its optional URI delimiters.
- hasTrailingSlash() : bool
- Returns whether or not the path has a trailing delimiter.
- isAbsolute() : bool
- Returns whether or not the path is absolute or relative.
- jsonSerialize() : string|null
- Returns the instance json representation.
- withContent() : self
- Returns an instance with the specified content.
- withLeadingSlash() : self
- Returns an instance with a leading slash.
- withoutDotSegments() : self
- Returns an instance without dot segments.
- withoutLeadingSlash() : self
- Returns an instance without a leading slash.
- withoutTrailingSlash() : self
- Returns an instance without a trailing slash.
- withTrailingSlash() : self
- Returns an instance with a trailing slash.
Methods
__toString()
Returns the instance string representation.
public
__toString() : string
If the instance is defined, the value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.
If the instance is not defined an empty string is returned
Return values
string —decoded()
Returns the decoded path.
public
decoded() : string
Return values
string —getContent()
Returns the instance content.
public
getContent() : string|null
If the instance is defined, the value returned MUST be encoded according to the selected encoding algorithm. In any case, the value MUST NOT double-encode any character depending on the selected encoding algorithm.
To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3. or RFC 3987 Section 3. By default the content is encoded according to RFC3986
If the instance is not defined null is returned
Return values
string|null —getUriComponent()
Returns the instance string representation with its optional URI delimiters.
public
getUriComponent() : string
The value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986, Sections 2 and 3.
If the instance is not defined an empty string is returned
Return values
string —hasTrailingSlash()
Returns whether or not the path has a trailing delimiter.
public
hasTrailingSlash() : bool
Return values
bool —isAbsolute()
Returns whether or not the path is absolute or relative.
public
isAbsolute() : bool
Return values
bool —jsonSerialize()
Returns the instance json representation.
public
jsonSerialize() : string|null
If the instance is defined, the value returned MUST be percent-encoded, but MUST NOT double-encode any characters. To determine what characters to encode, please refer to RFC 3986 or RFC 1738.
If the instance is not defined null is returned
Return values
string|null —withContent()
Returns an instance with the specified content.
public
withContent(string|null $content) : self
This method MUST retain the state of the current instance, and return an instance that contains the specified content.
Users can provide both encoded and decoded content characters.
A null value is equivalent to removing the component content.
Parameters
- $content : string|null
Tags
Return values
self —withLeadingSlash()
Returns an instance with a leading slash.
public
withLeadingSlash() : self
This method MUST retain the state of the current instance, and return an instance that contains the path component with a leading slash
Tags
Return values
self —withoutDotSegments()
Returns an instance without dot segments.
public
withoutDotSegments() : self
This method MUST retain the state of the current instance, and return an instance that contains the path component normalized by removing the dot segment.
Tags
Return values
self —withoutLeadingSlash()
Returns an instance without a leading slash.
public
withoutLeadingSlash() : self
This method MUST retain the state of the current instance, and return an instance that contains the path component without a leading slash
Tags
Return values
self —withoutTrailingSlash()
Returns an instance without a trailing slash.
public
withoutTrailingSlash() : self
This method MUST retain the state of the current instance, and return an instance that contains the path component without a trailing slash
Tags
Return values
self —withTrailingSlash()
Returns an instance with a trailing slash.
public
withTrailingSlash() : self
This method MUST retain the state of the current instance, and return an instance that contains the path component with a trailing slash