Ultimate generator.yml file for sfSurfaceGenerator

generator.yml

# $PARAMS: related_class=$PHP_CLASS completion_url=$URL add_url=$URL peer_method=$PHP_METHOD mailto=true|false size=$INTEGERx$INTEGER|size=$INTEGER increment=$INTEGER no_input=true|false min=$STRING max=$STRING unit=$STRING decimals=$INTEGER popup_height=$INTEGER popup_width=$INTEGER default=0|1 filter_default=0|1 default_value=TODO? date_format=$PHP_DATE_FORMAT from_hour=$INTEGER from_minutes=$INTEGER step_minutes=$INTEGER text_method=$PHP_METHOD text=$STRING rich=fck??? tool=Simple??? through_class=$PHP_CLASS
# $EXPORT_PARAMS: weight=$INTEGER label=true|false readonly=readonly
# $CREDENTIALS: [ truc/machin ]
# $FIELD_TYPE: textarea_tag|surface_autocomplete_peer|input_hidden_tag|input_time_tag|surface_boolean_tag|input_color_tag|input_number_tag|input_minutes_tag|checkbox_with_label|surface_link_to|workflow_view_mode|workflow_namespace|surface_autocomplete_list|surface_autocomplete|select_tag|input_tag|surface_double_list|assoc_files
# $MAGIC_STRING: $STRING # Will replace all %%FIELD_NAME%% by the actual value of the targeted field
# $TARGET: tg_center|tg_east|tg_lightbox|notices|popup|$HTML_ID

generator:
  class:                                sfSurfaceGenerator
  param:
    model_class:                        $PHP_CLASS
    singular_name:                      $SINGULAR_NAME
    theme:                              default

    behaviors:
      cart:
        active:                         true|false
        active_actions:                 true|false
        separate_actions:               true|false
        filter:                         true|false
        add_remove_all:                 true|false

      tree:
        active:            true|false

    helpers: [ $HELPER_NAME ]

    fields:
      $FIELD_NAME:
        name: $STRING
        type: $FIELD_TYPE
        label: on|off
        params: $PARAMS
        class: $CSS_CLASS
        help: $STRING
        field_name: $FIELD_NAME
        export_params: $EXPORT_PARAMS
        null_value: $STRING
        sort: true|false

    fieldsets:
      $CUSTOM_KEY:
        name: $STRING
        credentials:   $CREDENTIALS
        allow_method: $PHP_METHOD

    actions:
      _show|_create|_edit|_delete_confirm|$CUSTOM_KEY:
        name: $STRING
        icon: $IMAGE_URL
        no_label: on|off
        action: $ACTION_URL
        target: $TARGET
        credentials: $CREDENTIALS
        params: $PARAMS
        class: $CSS_CLASS
        confirm: $STRING
        redirect_url: $URL
        redirect_action: show|edit|create|delete_confirm|$ACTION_URL
        skip_navigation: true|false
        component_class_update: $MODULE

    exports:
      $ACTION_KEY:
        name:        $MAGIC_STRING
        outputType:   pdf|doc|xls|ods|odt
        icon:  $IMAGE_URL
        action:   $ACTION_URL
        credentials:  $CREDENTIALS
        template: $TEMPLATE_NAME # Probably not working
        selectable:                   true
        target:                       $TARGET
        format:                       A4|A3|A5
        filename:                     $TEMPLATE_NAME
        endpaper:                     true|false
        close_page:                   true|false
        display:                      [ $FIELD_NAME|_$FIELD_NAME|+$FIELD_NAME|=$FIELD_NAME|~$FIELD_NAME|+=$FIELD_NAME|+~$FIELD_NAME|+_$FIELD_NAME ]
        ajax_options:                 $PARAMS
        params:
          class:   $CSS_CLASS
          confirm: $STRING

    show|create|edit|delete_confirm|$ACTION_NAME:
      title:                            $MAGIC_STRING
      render:                           slots|tabs
      display: # ARRAY OF FIELDS IS ALLOWED
        $CUSTOM_KEY:                    [ $FIELD_NAME|_$FIELD_NAME|+$FIELD_NAME|=$FIELD_NAME|~$FIELD_NAME ] #MORE FIELDSET ARRAYS ARE ALLOWED
      menu:
        items:
          $MENU_ITEM:
            label: $STRING
            icon:  $IMAGE_URL
            title:  $STRING
            link:  #TODO
            target:  $TARGET
            is_ajax:   true|false
            skip_navigate:  true|false
            is_controller:   true|false
            allow:     $CREDENTIALS
            class:     $CSS_CLASS
            items:
              $MENU_ITEM: ...
            render:
              helper: $HELPER_NAME
              function: $FUNCTION_NAME

    list:
      title:                            $MAGIC_STRING
      display:                          [ $FIELD_NAME|_$FIELD_NAME|+$FIELD_NAME|=$FIELD_NAME|~$FIELD_NAME ]
      filters:                          [ $FIELD_NAME ] #ARRAY OF FILTERS IS ALLOWED
      layout:                           stacked| #TODO
      sort:                             [ $FIELD_NAME, asc|desc ]
      max_per_page:                     $INTEGER
      object_actions_skip:              true|false
      bottom_pager_skip:                true|false
      top_pager_skip:                   true|false
      header_skip:                      true|false
      pager_steps:                      [ $INTEGER ]
      tr_class:                         [ $PHP_METHOD ]
      td_class:                         [ $PHP_METHOD ]
      inline_editing:
        type:                              full
        display:                           [ $FIELD_NAME|_$FIELD_NAME|+$FIELD_NAME|=$FIELD_NAME|~$FIELD_NAME ] #MUST CORRESPOND TO list.display
        hide_form:                         true|false
      exports:
        $ACTION_KEY: ...
      actions:
        $ACTION_KEY: ...
      object_actions:
        $ACTION_KEY: ...
      cart: ...

      
    components:

      component_name:
        type:                           list|fields
        

    wizards:
      $WIZARD_NAME:
        title:                               $MAGIC_STRING
        showStepNumber:                      true|false
        steps:
          $WIZARD_STEP:
            label:                           $STRING
            title:                           $STRING
            note:                            $STRING
            header:                          $STRING
            fields:                          [ $FIELD_NAME|_$FIELD_NAME|+$FIELD_NAME|=$FIELD_NAME|~$FIELD_NAME ]