tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

DOC Document requirements for Configurable trait

Browse Source
This commit is contained in:
Damian Mooyman 2018-04-26 12:35:02 +12:00 committed by GitHub
commit d4bc386b34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/02_Developer_Guides/04_Configuration/00_Configuration.md
View File

@ -54,12 +54,27 @@ This can be done by calling the static method [Config::inst()](api:SilverStripe\
$config = Config::inst()->get('MyClass', 'property'); $config = Config::inst()->get('MyClass', 'property');
``` ```
Or through the `config()` object on the class. Or through the `config()` method on the class.
```php ```php
$config = $this->config()->get('property')'; $config = $this->config()->get('property')';
``` ```
You may need to apply the [Configurable](api:SilverStripe\Core\Config\Configurable) trait in order to access the `config()` method.
**mysite/code/MyOtherClass.php**
```php
use SilverStripe\Core\Config\Configurable;
class MyOtherClass
{
use Configurable;
}
```
Note that by default `Config::inst()` returns only an immutable version of config. Use `Config::modify()` Note that by default `Config::inst()` returns only an immutable version of config. Use `Config::modify()`
if it's necessary to alter class config. This is generally undesirable in most applications, as modification if it's necessary to alter class config. This is generally undesirable in most applications, as modification
of the config can immediately have performance implications, so this should be used sparingly, or of the config can immediately have performance implications, so this should be used sparingly, or