1. class
  2. SilverStripe
  3. \
  4. Core
  5. \
  6. Manifest
  7. \
  8. ModuleResource

ModuleResource

class ModuleResource

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.

Methods

__construct(Module $module, string $relativePath)

ModuleResource constructor.

string
getPath()

Return the full filesystem path to this resource.

string
getRelativePath()

Get the path of this resource relative to the base path.

string
getURL()

Public URL to this resource.

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.

Details

at line 40
__construct(Module $module, string $relativePath)

ModuleResource constructor.

Parameters

Module $module
string $relativePath

at line 57
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.

Return Value

string Path with no trailing slash E.g. /var/www/module

at line 70
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.

Return Value

string Relative path (no leading /)

at line 89
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.

Return Value

string

Synonym for getURL() for APIs that expect a Link method

Return Value

mixed

at line 111
bool exists()

Determine if this resource exists

Return Value

bool

at line 121
string __toString()

Get relative path

Return Value

string

at line 129
Module getModule()

Return Value

Module

at line 141
ModuleResource getRelativeResource(string $path)

Get nested resource relative to this.

Note: Doesn't support .. or . relative syntax

Parameters

string $path

Return Value

ModuleResource