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

Document requirements for Configurable trait

Browse Source
This commit is contained in:
Al 2018-04-26 10:49:38 +12:00 committed by GitHub
parent e9d3996a4c
commit 4a0148a2bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,6 +60,21 @@ Or through the `config()` object on the class.
$config = $this->config()->get('property')'; $config = $this->config()->get('property')';
``` ```
If your class does not inherit from a SilverStripe class, you must apply the [Configurable](api:SilverStripe\Core\Config\Configurable) trait in order to access the `config()` object.
**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