sheadawson/quickaddnew

A decorator for form fields that manage object relationships, to allow adding a new object on the fly through a dialog window. It can handle has_one, has_many or many_many relationships. At the moment it has been tested / works on DropdownField and ListboxField. It works both in the CMS and in the f

2.0.0 2024-11-08 10:31 UTC

Requires

• php: ^7.4 || ^8
• silverstripe/framework: ^4.4 || ^5
• silverstripe/recipe-plugin: ^1 || ^2
• silverstripe/vendor-plugin: ^1 || ^2

Requires (Dev)

• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5

Replaces

• silverstripe/quickaddnew: *

BSD-3-Clause

• Shea Dawson
• LeKoala

README

What is it?

A decorator for form fields that manage object relationships, to allow adding a new object on the fly through a dialog window. It can handle has_one,has_many or many_many relationships. At the moment it has been tested / works on DropdownField (and SearchableDropdownField), ListboxField and CheckboxSetField. It works both in the CMS and in the frontend.

Requirements

SilverStripe 4/5

For SilverStripe, check branch 1.1

Usage

Firstly, when creating the form field, we need to create a closure that returns the source array to populate the field's options. We do this because later on, when the field is refreshed with the newly created Object ID as it's value, we need to use this function Again to get up to date data for the source.

$source = function(){
    return MyObject::get()->map()->toArray();
};

Then we can create the form field, calling the closure as the source argument

$field = DropdownField::create('MyObjectID', 'My Object', $source());
// or...
$field = ListboxField::create('MyObjects', 'My Objects', $source());
// or...
$field = CheckboxSetField::create('MyObjects', 'My Objects', $source());

Next, we can tell the field to use and configure quickaddnew with useAddNew.

• The first parameter is the class name of the object that will be created.
• The second is the $source closure
• (optional) The third allows you to pass a specific set of fields to display in the dialog
• (optional) The fourth allows you to pass a validator
• (optional) The fifth allows you to specify if this is a frontend field

These allow you to customise the fields and required fields (for validation) for the dialog. By default the object class's getAddNewFields() or getCMSFields() methods are used

$field->useAddNew('MyObject', $source);
// or...
$field->useAddNew('MyObject', $source, $fields, $required, $isFrontend);

Add the field to your FieldList

$fields->addFieldToTab('Root.Main', $field);