Much like the sfConfig::get()
method, use csSettings::get()
to call dynamic, user-defined settings.
An admin generator interface allows easy administration.
All settings are cached when first loaded, and the cache is refreshed whenever a setting is changed or added.
After the settings have been loaded, retrieve them with csSettings::get()
(returns a string value) or csSettings::getSetting()
(returns a csSetting object)
To create a setting, you can add one in using a fixture, or using the DIY admin module interface (see below)
# in YAML fixture:
csSetting:
test_setting:
name: My Fake Setting
type: yesno # optional: defaults to 'input'
setting_default: 'yes' # optional, defaults to empty string
widget_options: class=my-fake-setting # optional, more on this below
You can pull your setting into your project with the class method get
. This takes
either the name of your setting or the inflected name of your setting.
$value = csSettings::get('My Fake Setting'); // The name of your setting
$value = csSettings::get('my_fake_setting'); // This will also work
You can also use csSettings to call settings in your app.yml. By default, if the value passed
to the get
method is null, sfConfig
is called:
$value = csSettings::get('this_setting_does_not_exist');
// If a csSetting does not exist with this name, this returns the same as:
$value = sfConfig::get('app_this_setting_does_not_exist');
// This also works:
$value = csSettings::get('This Setting Does Not Exist');
Alternatively, the entire csSetting
object can be returned by calling the class method
getSetting
:
$setting = csSettings::getSetting('my_fake_setting');
An admin module also exists for managing the settings in the database. you must enable the module in order to access it
# /apps/myapp/config/settings.yml
all:
.settings:
enabled_modules: [default, csSetting]
This module can be used to edit the variables as the plugin was originally built with the value for the setting being on the list page and editable from there, or it can behave like a normal admin-generated page. By default, you must be authenticated to edit the setting configurations themselves.
If you want to prevent validated users from editing the setting configurations, you can override the authMethod setting in your app.yml:
# /config/app.yml
all:
csSettingsPlugin:
authMethod: isSuperAdmin # or whatever method you want called on myUser.
Not happy with the available options? Want to customize widgets and validators for your settings? Get your code gloves on. Lets say you have a setting called image_path that you want to validate in a certain way. You want to make sure the URL submitted is valid. You can accomplish this as follows:
# /path/to/project/lib/form/doctrine/csSettingsPlugin/csSettingForm.class.php
function getImagePathSettingValidator()
{
return new sfValidatorUrl();
}
Likewise, if you have a custom widget you can do the same like this:
# /path/to/project/lib/form/doctrine/csSettingsPlugin/csSettingForm.class.php
function getImagePathSettingWidget()
{
return new myCustomWidget();
}
You can even override the widgets and validators by their type. For instance, if you want to use the tinyMCE widget instead of the default CKEditor Widget, you could do something like this:
# /path/to/project/lib/form/doctrine/csSettingsPlugin/csSettingForm.class.php
public function getRichTextSettingWidget()
{
return new sfWidgetFormTextareaTinyMCE(array(), $this->getObject()->getOptionsArray());
}
This will use the TinyMCE widget and also include the options specified in the setting's widget_options property. The same is possible with validators:
# /path/to/project/lib/form/doctrine/csSettingsPlugin/csSettingForm.class.php
public function getRichTextSettingValidator()
{
return new sfValidatorHtml(array('strip_tags' => true));
}
Customize the cache handler for your settings using your app.yml. By default, sfNoCache is used.
# /config/app.yml
all:
csSettingsPlugin:
cache:
class: sfFileCache
options:
automatic_cleaning_factor: 0
cache_dir: %SF_TEMPLATE_CACHE_DIR%
lifetime: 86400
prefix: %SF_APP_DIR%/template
Please contact bshafs at gmail dot com for any questions or suggestions.