VersionProvider
class VersionProvider (View source)
The version provider will look up configured modules and examine the composer.lock file to find the current version installed for each. This is used for the logo title in the CMS via LeftAndMain::CMSVersion()
Example configuration:
SilverStripe\Core\Manifest\VersionProvider:
modules:
# package/name: Package Title
silverstripe/framework: Framework
silverstripe/cms: CMSTraits
Provides extensions to this object to integrate it with standard config API methods.
A class that can be instantiated or replaced via DI
Config options
| modules | array |
Properties
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Gets the configured core modules to use for the SilverStripe application version
Tries to obtain version number from composer.lock if it exists
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
string
getVersion()
Gets a comma delimited string of package titles and versions
string
getModuleVersion(string $module)
Get the version of a specific module
array
getModules()
Gets the configured core modules to use for the SilverStripe application version
array
getModuleVersionFromComposer(array $modules = [])
Tries to obtain version number from composer.lock if it exists
protected array
getComposerLock(bool $cache = true)
Load composer.lock's contents and return it
protected string
getComposerLockPath()
No description