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

Module

class Module implements Serializable (View source)

Abstraction of a PHP Package. Can be used to retrieve information about Silverstripe CMS modules, and other packages managed via composer, by reading their composer.json file.

Constants

TRIM_CHARS

CI_PHPUNIT_NINE

Return value of getCIConfig() when module uses PHPUNit 9
CI_PHPUNIT_FIVE

Return value of getCIConfig() when module uses PHPUNit 5
CI_UNKNOWN

Return value of getCIConfig() when module does not use any CI

Methods

__construct(string $path, string $basePath)

Construct a module

string
getName()

Gets name of this module. Used as unique key and identifier for this module.

string|null
getComposerName()

Get full composer name. Will be null if no composer.json is available

array
getExposedFolders()

Get list of folders that need to be made available

string
getShortName()

Gets "short" name of this module. This is the base directory this module is installed in.

string
getResourcesDir()

Name of the resource directory where vendor resources should be exposed as defined by the extra.resources-dir key in the composer file. A blank string will be returned if the key is undefined.

string
getPath()

Get base path for this module

string
getRelativePath()

Get path relative to base dir.

array
__serialize()

No description

void
__unserialize(array $data)

No description

string
serialize() deprecated

The __serialize() magic method will be automatically used instead of this

unserialize(string $serialized) deprecated

The __unserialize() magic method will be automatically used instead of this almost all the time This method will be automatically used if existing serialized data was not saved as an associative array and the PHP version used in less than PHP 9.0

activate()

Activate _config.php for this module, if one exists

ModuleResource
getResource(string $path)

Get resource for this module

string
getRelativeResourcePath(string $path) deprecated

No description

string
getResourcePath(string $path) deprecated

No description

string
getResourceURL(string $path) deprecated

No description

string
hasResource(string $path) deprecated

No description

Details

at line 78
__construct(string $path, string $basePath)

Construct a module

Parameters

string $path

Absolute filesystem path to this module
string $basePath

base path for the application this module is installed in

at line 93
string getName()

Gets name of this module. Used as unique key and identifier for this module.

If installed by composer, this will be the full composer name (vendor/name). If not installed by composer this will default to the basedir()

Return Value

string

at line 103
string|null getComposerName()

Get full composer name. Will be null if no composer.json is available

Return Value

string|null

at line 116
array getExposedFolders()

Get list of folders that need to be made available

Return Value

array

at line 132
string getShortName()

Gets "short" name of this module. This is the base directory this module is installed in.

If installed in root, this will be generated from the composer name instead

Return Value

string

at line 160
string getResourcesDir()

Name of the resource directory where vendor resources should be exposed as defined by the extra.resources-dir key in the composer file. A blank string will be returned if the key is undefined.

Only applicable when reading the composer file for the main project.

Return Value

string

at line 172
string getPath()

Get base path for this module

Return Value

string

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

at line 183
string getRelativePath()

Get path relative to base dir.

If module path is base this will be empty string

Return Value

string

Path with trimmed slashes. E.g. vendor/silverstripe/module.

at line 191
array __serialize()

Return Value

array

at line 200
void __unserialize(array $data)

Parameters

array $data

Return Value

void

at line 214
string serialize() deprecated

deprecated 4.12.0 Use __serialize() instead

The __serialize() magic method will be automatically used instead of this

Return Value

string

at line 228
unserialize(string $serialized) deprecated

deprecated 4.12.0 Use __unserialize() instead

The __unserialize() magic method will be automatically used instead of this almost all the time This method will be automatically used if existing serialized data was not saved as an associative array and the PHP version used in less than PHP 9.0

Parameters

string $serialized

at line 238
activate()

Activate _config.php for this module, if one exists

at line 270
ModuleResource getResource(string $path)

Get resource for this module

Parameters

string $path

Return Value

ModuleResource

at line 287
string getRelativeResourcePath(string $path) deprecated

deprecated 4.0.1 Use getResource($path)->getRelativePath() instead

Parameters

string $path

Return Value

string

at line 300
string getResourcePath(string $path) deprecated

deprecated 4.0.1 Use getResource($path)->getPath() instead

Parameters

string $path

Return Value

string

at line 313
string getResourceURL(string $path) deprecated

deprecated 4.0.1 Use getResource($path)->getURL() instead

Parameters

string $path

Return Value

string

at line 326
string hasResource(string $path) deprecated

deprecated 4.0.1 Use getResource($path)->exists() instead

Parameters

string $path

Return Value

string