ModuleResource
class ModuleResource (View source)
This object represents a single resource file attached to a module, and can be used as a reference to this to be later turned into either a URL or file path.
Properties
| protected | Module | $module | ||
| protected | string | $relativePath | Path to this resource relative to the module (no leading slash) |
|
| protected | ModuleResource[] | $resources | Nested resources for this parent resource |
Methods
Details
__construct(Module $module, string $relativePath)
ModuleResource constructor.
string
getPath()
Return the full filesystem path to this resource.
Note: In the case that this resource is mapped to the _resources folder, this will
return the original rather than the copy / symlink.
string
getRelativePath()
Get the path of this resource relative to the base path.
Note: In the case that this resource is mapped to the _resources folder, this will
return the original rather than the copy / symlink.
string
getURL()
Public URL to this resource.
Note: May be either absolute url, or root-relative url
In the case that this resource is mapped to the _resources folder this
will be the mapped url rather than the original path.
mixed
Link()
Synonym for getURL() for APIs that expect a Link method
bool
exists()
Determine if this resource exists
string
__toString()
Get relative path
Module
getModule()
No description
ModuleResource
getRelativeResource(string $path)
Get nested resource relative to this.
Note: Doesn't support .. or . relative syntax