scopes.md

SettingsBundle

• Installation
• General usage
• Scopes
• Advanced configuration
• I18n
• Customization
• FAQ

Understanding scopes

Bundle provides settings separation into 3 scopes: ALL, GLOBAL and USER.

• GLOBAL and USER scopes are totally independent.
• ALL scope provides you to inherit global settings when user setting with the same name is not setted.

Examples must give more clearance:

<?php

// Example with ALL scope
$settingsMaanger->set('all_scope_setting', 'value');
$settingsMaanger->get('all_scope_setting'); // => 'value'
$settingsMaanger->get('all_scope_setting', $this->getUser()); // => 'value'
$settingsMaanger->set('all_scope_setting', 'user_value', $this->getUser());
$settingsMaanger->get('all_scope_setting', $this->getUser()); // => 'user_value'

// Example #1 with GLOBAL and USER scopes
$settingsMaanger->set('global_scope_setting', 'value');
$settingsMaanger->get('global_scope_setting'); // => 'value'
$settingsMaanger->get('global_scope_setting', $this->getUser()); // => WrongScopeException
$settingsMaanger->set('global_scope_setting', 'value', $this->getUser()); // => WrongScopeException

// Example #2 with GLOBAL and USER scopes
$settingsMaanger->set('user_scope_setting', 'value', $this->getUser());
$settingsMaanger->get('user_scope_setting', $this->getUser()); // => 'value'
$settingsMaanger->get('user_scope_setting'); // => WrongScopeException
$settingsMaanger->set('user_scope_setting', 'value'); // => WrongScopeException

Configuring scope

You may configure a scope to each of your settings. You can use ALL (default), GLOBAL or USER scope.

dmishh_settings:
    settings:
        my_first_user_setting:
            scope: user # all, global