i-lateral/silverstripe-fancy-form-scaffolder

Allows you to defined CMS form structure via config.yml

1.0.3 2021-06-11 14:05 UTC

Requires

• silverstripe/admin: ~1.0
• silverstripe/framework: >=4.2

BSD-3-Clause

• ilateral

• admin
• Forms
• scaffold
• silverstripe

README

The standard CMS Form Scaffolder does a good job of automatically creating forms to edit records in the SilverStripe admin, but if you want to create complex form layouts (adding fields to field groups, composite fields, custom tabs, etc) then you will have to spend a lot of time editing getCMSFields.

This module allows scaffolding of complex form layouts in the SilverStripe CMS via YML config. You can defined tabs, field types, field groupings and assotiations via some arrays in configuration.

Installing

You can install via composer:

composer require i-lateral/silverstripe-fancy-form-scaffolder

Usage

Once installed, simply add a cms_fields config variable to your DataObject and FormScaffolder will build all CMS forms (loaded using Form Scaffolding) for that object using the FormScaffolder.

Example Config

class Product extends DataObject
{
    private static $db = [
        'Name' => 'Varchar',
        'StockID' => 'Varchar',
        'Description' => 'HTMLText',
        'Price' => 'Currency',
        'ItemsPerCarton' => 'Int'
    ];

    private static $has_one = [
        'Supplier' => Factory::class
    ];

    private static $many_many = [
        'Categories' => Category::class
    ];

    private static $cms_fields = [
        'Root.Main' => [
            'fields' => [
                'ProductDetails' => 'h2',
                'Title/StockID' => [
                    'type' => \SilverStripe\Forms\FieldGroup::class,
                    'fields' => [
                        'Title',
                        'StockID'
                    ]
                ],
                'Description',
                'Price/Cartons' => [
                    'type' => 'SilverStripe\Forms\CompositeField',
                    'fields' => [
                        'BasePrice',
                        'ItemsPerCarton',
                        'SupplierID'
                    ]
                ]
            ]
        ],
        'Root.Components' => [
            'fields' => [
                'Additions'
            ]
        ]
    ];
}

Calling field methods on construction

You can also call field methods when the scaffolder constructs/retrieves the field.

This can be usefull for performing tasks, such as changing a field title or defining a number of columns on a CompositeField. You can do this using the following example:

'Title/StockID' => [
    'type' => \SilverStripe\Forms\CompositeField::class,
    'fields' => [
        'Title',
        'StockID'
    ],
    'methods' => [
        'setTitle' => '',
        'setColumnCount' => 2
    ]
]