Development

Changeset 3195

You must first sign up to be able to contribute.

Changeset 3195

Show
Ignore:
Timestamp:
01/08/07 19:01:41 (6 years ago)
Author:
francois
Message:

[sfControlPanelPlugin] updated readme file

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • plugins/sfControlPanelPlugin/README

    r3149 r3195  
    1717{{{ 
    1818dev: 
    19   enabled_modules: [default, sfControlPanel] 
     19  .settings: 
     20    enabled_modules: [default, sfControlPanel] 
    2021}}} 
    2122 
    …… 
    7879The `sfControlPanel` plugin proposes a data explorer that will use the connection settings of your `databases.yml` to connect to a database and display the list of tables it contains. Based on the admin generator, each table can be browsed, and each record can be edited or deleted, pretty much like what phpMyAdmin offers. 
    7980 
    80 Each table explorer being automatically generated by symfony, you can add custom generator settings to alter which fields, filters, actions and sort criterias are used, the asme way as you usually customized an admin generated theme. For that purpose, create a `sfControlPanel_generator.yml` file in the project's `config/folder`, and add in any generator customization you want. The primary labels are classes.  
     81Each table explorer being automatically generated by symfony, you can add custom generator settings to alter which fields, filters, actions and sort criterias are used, the same way as you usually customized an admin generated theme. For that purpose, create a `sfControlPanel_generator.yml` file in the project's `config/folder`, and add in any generator customization you want. The primary labels are classes.  
    8182 
    8283So for instance, if your database contains an `article` table, you can customize the fields displayed in the `list` view by writing in the `config/sfControlPanel_generator.yml`: 
    …… 
    113114== Known limitations == 
    114115 
     116If your routing policy is not compatible with the default rules (`/:module` and `/:module/:action`), you have to define specific rules for the `sfControlPanel` module by adding at the beginning of your `routing.yml`:  
     117{{{  
     118sfControlPanel_index:  
     119  url:   /sfControlPanel  
     120  param: { module: sfControlPanel, action: index }  
     121 
     122sfControlPanel:  
     123  url:   /sfControlPanel/:action/*  
     124  param: { module: sfControlPanel }  
     125}}}  
     126 
    115127The plugin is not compatible with projects having a custom directory structure. 
    116128 
    …… 
    118130 
    119131Due to a bug in the view config handler, the presentation of the `sfControlPanel` plugin will be buggy if your application's `view.yml` contains default stylesheets. 
     132