Docs update

This commit is contained in:
Paweł Klockiewicz
2017-04-15 20:23:03 +02:00
parent 4d7b0543bb
commit 76e264b3bf
2 changed files with 5 additions and 11 deletions

View File

@@ -573,18 +573,15 @@ $this->notify('success', 'This is %s!', $foo); // $this->core->setNotify('succes
mixed settings(string $module [, string $field [, string $value]])
```
Gets or sets the value of the module settings. By default these are the main Batflat settings.
Gets or sets the value of the module settings.
#### Arguments
+ `module` the module name, the name of the Batflat settings field, or the module name and the field set with a dot
+ `module` — module name and optionally field separated by a period
+ `field` — module field name *(optional)*
+ `value` — the value to which module field will be changed *(optional)*
+ `value` — the value to which module field will be changed *(optional)*
#### Example
```php
// Select the "title" field from the general system settings
$this->settings('title'); // $this->core->getSettings('title');
// Select the "desc" field from the "blog" module
$this->settings('blog.desc'); // $this->core->getSettings('blog', 'desc');

View File

@@ -573,18 +573,15 @@ $this->notify('success', 'This is %s!', $foo); // $this->core->setNotify('succes
mixed settings(string $module [, string $field [, string $value]])
```
Pobiera lub ustawia wartość ustawień danego modułu. Domyślnie są to główne ustawienia Batflata.
Pobiera lub ustawia wartość ustawień danego modułu.
#### Argumenty
+ `module` — nazwa modułu, nazwa pola ustawień Batflata lub nazwa modułu i pole ustawień połączone kropką
+ `module` — nazwa modułu i opcjonalnie nazwa pola oddzielona kropką
+ `field` — nazwa pola modułu *(opcjonalne)*
+ `value` — wartość na jaką zostanie zmienione pole modułu *(opcjonalne)*
#### Przykład
```php
// Pobranie pola "title" z ogólnych ustawień systemu
$this->settings('title'); // $this->core->getSettings('title');
// Pobranie pola "desc" z modułu "blog"
$this->settings('blog.desc'); // $this->core->getSettings('blog', 'desc');