sfAdminTemplatePlugin - 1.0.1

Vincent CHALAMON

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to the Plugins Home

Signin


Forgot your password?
Create an account

Tools

Stats

advanced search
Information Readme Releases Changelog Contribute
Show source

Vincent CHALAMON vincentchalamon@gmail.com

Configuration

Ce plugin symfony 1.4 fournit un thème d'administration avec son propre Admin Generator. Il peut être combiné avec le plugin sfEPFactoryFormPlugin.

View.yml

Vous souhaitez utiliser ce thème sur toute votre application ou simplement un module ? Il vous suffit d'éditer (ou créer) le fichier view.yml du répertoire config de votre application ou module, et d'y appliquer l'un des layouts proposé par le plugin :

  • admin : thème général avec le menu
  • clean : thème réduit, pour l'authentification ou les pages d'erreur

Vous pouvez rajouter autant de thèmes que nécessaire afin de les prendre en compte par le plugin, cela chargera les javascripts et css nécessaires au plugin. Par exemple, pour rajouter un layout fancybox, éditer le fichier app.yml :

all:
  sf_admin_template:
    templates: [admin, clean, fancybox]

Authentification

Afin de garder une homogénéité à travers toute l'administration, les templates du module sfGuardAuth ont été surchargés. Pour cela, copiez le répertoire /sfAdminTemplatePlugin/modules/sfGuardAuth, et collez-le dans le répertoire modules de votre application.

Menu

Ce plugin vous permet d'intégrer dynamiquement un menu en haut du thème admin. Pour cela, éditer le fichier app.yml :

all:
  sf_admin_template:
    menus:
      article:
        label: Articles
        credentials: []
        route_prefix: article
  • label [string, requis] : intitulé du lien dans le menu
  • credentials [array, optionnel] : liste des credentials requises par l'utilisateur pour voir le lien
  • route_prefix [string, optionnel] : url symfony (route_name, @route_name, action/module). par défaut, récupère le nom de menu ("article")

Admin Generator

Un thème personnalisé d'admin generator est intégré à ce plugin. Pour le prendre en compte dans vos modules, éditez le fichier generator.yml de votre module.

  • Renseignez le paramètre class par "sfAdminTemplateGenerator"
  • Renseignez le paramètre theme par "admin_template"
  • Renseignez le bloc show de la même manière que le bloc list, en renseignant les paramètres title et display.

Il est possible d'utiliser un template en colonnes pour vos formulaire d'admin generator. Pour cela, renseignez les paramètres suivants :

  • Ajouter un paramètre template au contexte (form, edit, new), et renseignez-le avec "columns"
  • Ajouter un paramètre columns au contexte (form, edit, new), et renseignez-le avec la liste des champs présents dans la colonne de droite : [name, url]
  • Renseignez le paramètre display du contexte (form, edit, new) avec la liste des champs présents dans la colonne principale : [contents, description]

Exemple de generator.yml :

generator:
  class: sfAdminTemplateGenerator
  param:
    model_class:           Article
    theme:                 admin_template
    non_verbose_templates: true
    with_show:             false
    singular:              ~
    plural:                ~
    route_prefix:          article
    with_doctrine_route:   true
    actions_base_class:    sfActions

    config:
      actions: ~
      fields:  ~
      list:
        title: Article
      show:
        title: %%name%%
        display: [name, value, slug]
      filter:  ~
      form:
        template: columns
        display: [contents, description]
        columns: [name, url]
      edit:    ~
      new:     ~