Username
Password

Information Readme Releases Changelog Contribute

sfDoctrineSettingsPlugin 1.2.4stable for sf 1.2 and Doctrine MIT

users

Sign-in
to change
your status

The sfDoctrineSettingsPlugin is a symfony plugin that provides app wide settings functionality. It automatically generates constant values based on sf_setting table values and make them accessible in every app module.

Backend

Developers

Name	Status	Email
Stephen Ostrow	lead	moc.sngisedbewos <<ta>> wortsos
synace	lead	moc.ecanys <<ta>> ynofmys
Jonathon Wage	developer	moc.liamg <<ta>> egawnoj

License

Show source

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version	License	API	Released
1.2.4stable	MIT license	1.2.0stable	22/02/2009
1.2.3stable	MIT license	1.2.0stable	22/02/2009
1.2.2stable	MIT license	1.2.0stable	22/02/2009
1.2.1stable	MIT license	1.2.0stable	09/02/2009
1.2.0stable	MIT license	0.1.0stable	01/02/2009

Version	License	API	Released
1.0.5stable	MIT license	0.1.0stable	19/12/2008
1.0.4stable	MIT license	0.1.0stable	09/12/2008
1.0.3stable	MIT license	0.1.0stable	02/12/2008
1.0.2stable	MIT license	0.1.0stable	18/11/2008
1.0.1stable	MIT license	0.1.0stable	08/11/2008

Join this plugin team

To join this plugin team, you must first sign in or create an account.

Changelog for release 1.2.4 - 22/02/2009

[15693]: Updating the readme file for format bug

Other releases

Release 1.2.4 - 22/02/2009

[15693]: Updating the readme file for format bug

Release 1.2.3 - 22/02/2009

[15692]: Updating the readme file for WYSIWYG field

Release 1.2.2 - 22/02/2009

[15689]: Cleaning up some old unneeded code from 1.0
[15688]: Updating the plugin to be able to use different edit forms for different types of settings
Added a custom forms for the different setting types currently in the system
[15678]: Putting back the choices which were removed by accident in r15639
[15640]: Removing closing php tag
[15639]: Trying to fix the plugin to stop generating an extra set of forms and filters in the wrong directory
[15638]: Adding a blank configure method to this to try and correct the generating of form classes in the wrong place
[15636]: Fixing a type-o in the readme

Release 1.2.1 - 09/02/2009

Fixing the issues for the module sfSettings in 1.2
Using the correct admin generator generator.yml format
Updating the actions file to include the correct admin generator classes
Moving the actions logic to an included base class so it can be overwritten
Added a pluginConfiguration class
Added a routing class for the plugin to setup the proper routes
Removing the id field from the schema as doctrine will automatically provide this for us
Moving the choices for type into the model
Updating the type field in the form to use the choicesWidget

Release 1.2.0 - 01/02/2009

Upgrading the plugin to make it work with 1.2

Release 1.0.5 - 19/12/2008

Removing the save button from the list view if we're not using the single page display

Release 1.0.4 - 09/12/2008

Fixing a bug where if there are no current settings an undefined array notice is thrown
Fixing a bug where when using the non-single page mode the value is not saved. Both modes will now work correctly.

Release 1.0.3 - 02/12/2008

Making the generator file look at a app.yml setting to decide whether to have the values editable on the list page or the edit page.

Release 1.0.2 - 18/11/2008

Changing my email on this package

Release 1.0.1 - 08/11/2008

Making the backend work with sfDoctrinePlugin 1.0
Making the wysiwyg editor use the options field for extra options
Updating the README file to be more helpful

Show source

Symfony Doctrine Settings Plugin

This plugin allows the easy use of a basic dynamic settings table. It will create sf_settings, and allow the use of an admin generator interface (via the sfSettings module) in order to add/edit/delete settings.

Since loading a setting requires a query to the database, performance ramifications are best mitigated by using sfSettings:load() to pre-load settings in the action for use elsewhere, i.e.:

Frontend

<?php
sfSettings::load(array('setting1', 'setting2', 'setting3'));

If you have settings that you know you will want loaded by default for every action, you can put those in config/defaults.yml.

# /config/defaults.yml
settings: [ setting_name_1, setting_name_2 ]

However you will also need to add a filter to the chain so that your settings get loaded, i.e. the following lines at the top of appname/config/filters.yml:

# /apps/public/config/filters.yml
settings:
  class: sfSettingsFilter

After the settings have been loaded, they are stored in memory for retrieval by sfSettings::get() (returns a string value) or sfSettings::getSetting() (returns an sfSetting object)

Backend

A admin/backend module also exists for managing the settings in the database. you must enable the module in order to access it

# /apps/backend/config/settings.yml
all:
  .settings:
     enabled_modules:        [default, sfSettings]

WYSIWYG field

In order to use the WYSIWYG field you must install sfFormExtraPlugin as well as the TINYMCE editor. After your app.yml file to tell the plugin to use the rich text editor

# /apps/backend/config/app.yml
all:
  sf_settings_plugin:
    rich_fields: false

Options Field for settings of types checkbox and select

When using the checkbox and select types you must use the options field to specify valid options for the value. The options field should be filled out as an arry in yaml format

# options field for types select and checkbox
value: 'The Label'
option2: 'Option 2'

New Types of Settings

If you would like to add more types of options to the sfSettingsPlugin you can override the $type_choices variable in your model.

# /lib/model/doctrine/sfSettingsPlugin/sfSettingTable.class.php
protected static $type_choices = array(
           'checkbox' =>  'Checkbox',
           'input'    =>  'Text Field',
           'textarea' =>  'Text Area',
           'wysiwyg'  =>  'Rich Text Area',
           'yesno'    =>  'Yes/No Radios',
           'select'   =>  'Select',
           'newCustomType' => 'New Custom Type',);

If you would like to set a custom widget for the value field when using this type make a new class in your project named sfSettingsSettingNewCustomTypeForm The example below is making the value field a Select box of choices from the options field

# /lib/form/sfSettingsSettingCheckboxForm.class.php
class sfSettingsSettingNewCustomTypeForm extends sfSettingForm
{
  public function configure()
  {
    parent::configure();
 
    $choices = sfYaml::load($this->getObject()->getOptions());
    if ( is_array($choices) && count($choices) ) {
      $this->widgetSchema['value'] = new sfWidgetFormChoice(array('choices' => $choices));
      $this->validatorSchema['value'] = new sfValidatorChoice(array('choices' => array_keys($choices)));
    } else {
      unset($this['value']);
    }
  }
}

Fields

id
- Used as the primary key
name
- Used as the variable name
- Must be unique
type
- Used to decide what type of editor is needed in the sfSettings backend
- Current Types
- checkbox
- input
- textbox
- yesno
- select
- wysiwyg
options
- select
- An array of options in yaml format
- checkbox
- An array of options in yaml format
- wysiwyg
- Will be appended to the text_area options after rich=true
value
- The value of the setting

sfDoctrineSettingsPlugin - 1.2.4

Allows for settings to stored in the database and recalled for use in the application.

Signin

Tools

Stats