fullscreeninteractive/silverstripe-keyvaluefield

A Silverstripe FormField for extending TextField with several parts (keys)

Maintainers

Details

github.com/fullscreeninteractive/silverstripe-keyvaluefield

Homepage

Source

Issues

Installs: 47

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:silverstripe-vendormodule

1.1.0 2024-07-22 04:16 UTC

Requires

Requires (Dev)

BSD-3-Clause 3cc6fcc9adc3f4c9122b5fe4c07484f663625dcb

silverstripeversioned

This package is auto-updated.

Last update: 2024-11-22 05:03:01 UTC

README

Version License

A reusable approach to a form field which extends a simple Text field to have several named parts (keys). This module also supports User Defined Forms.

Installation

composer require fullscreeninteractive/silverstripe-keyvaluefield

Usage

Image of Function

use FullscreenInteractive\KeyValueField\KeyValueField;

$fields = new FieldList(
    KeyValueField::create('Quantity', 'Enter quantity of each size')
        ->setKeys([
            'Small',
            'Medium',
            'Large'
        ])
);

When using ORM managed forms and models (i.e saveInto) data will be saved as a serialized array of the values to each of the keys. You can change this behaviour if needed in your Form class.

public function doSave($data, $form)
{
    $quantity = $form->dataFieldByName('Quantity');

    // returns an array of key => value
    $values = json_decode($quantity->dataValue(), true);

    echo $values['Small']
}

Licence

BSD 3-Clause License