ResourceInterface
Resource Interface.
Tags
Table of Contents
| getUri() | Get Resource URI. | string |
|---|---|---|
| getBasePath() | Get the resource base path, aka the path that comes after the `://`. | string |
| getFilename() | Extract the resource filename (test.txt -> test). | string |
| getBasename() | Extract the trailing name component (test.txt -> test.txt). | string |
| getExtension() | Extract the resource extension (test.txt -> txt). | string |
| getLocation() | ResourceLocationInterface|null | |
| __toString() | Magic function to convert the class into the resource absolute path. | string |
| getAbsolutePath() | string | |
| getPath() | string | |
| getLocatorBasePath() | string | |
| setLocatorBasePath() | static | |
| getSeparator() | string | |
| setSeparator() | static | |
| getStream() | ResourceStreamInterface |
Methods
getUri()
Get Resource URI.
public
getUri(
)
: string
Return values
stringgetBasePath()
Get the resource base path, aka the path that comes after the `://`.
public
getBasePath(
)
: string
Return values
stringgetFilename()
Extract the resource filename (test.txt -> test).
public
getFilename(
)
: string
Return values
stringgetBasename()
Extract the trailing name component (test.txt -> test.txt).
public
getBasename(
)
: string
Return values
stringgetExtension()
Extract the resource extension (test.txt -> txt).
public
getExtension(
)
: string
Return values
stringgetLocation()
public
getLocation(
)
: ResourceLocationInterface|null
Return values
ResourceLocationInterface|null__toString()
Magic function to convert the class into the resource absolute path.
public
__toString(
)
: string
Return values
string —The resource absolute path
getAbsolutePath()
public
getAbsolutePath(
)
: string
Return values
stringgetPath()
public
getPath(
)
: string
Return values
stringgetLocatorBasePath()
public
getLocatorBasePath(
)
: string
Return values
stringsetLocatorBasePath()
public
setLocatorBasePath(
$locatorBasePath :
string
)
: static
Parameters
- $locatorBasePath : string
Return values
staticgetSeparator()
public
getSeparator(
)
: string
Return values
stringsetSeparator()
public
setSeparator(
$separator :
string
)
: static
Parameters
- $separator : string
Return values
staticgetStream()
public
getStream(
)
: ResourceStreamInterface