Elements

Collection

Sometimes, you may want to add an input (or a set of inputs) multiple times, either because you don't want to duplicate code, or because you do not know in advance how many elements you will need (in the case of elements dynamically added to a form using Javascript, for instance). For more information about collections, please refer to the form Collections tutorial.

Laminas\Form\Element\Collection is meant to be paired with the Laminas\Form\View\Helper\FormCollection.

Basic Usage

use Laminas\Form\Element;
use Laminas\Form\Form;

$colors = new Element\Collection('collection');
$colors->setLabel('Colors');
$colors->setCount(2);
$colors->setTargetElement(new Element\Color());
$colors->setShouldCreateTemplate(true);

$form = new Form('my-form');
$form->add($colors);

Using array notation:

use Laminas\Form\Element;
use Laminas\Form\Form;

$form = new Form('my-form');
$form->add([
    'type' => Element\Collection::class,
    'options' => [
        'label' => 'Colors',
        'count' => 2,
        'should_create_template' => true,
        'target_element' => new Element\Color()
    ],
]);

Public Methods

The following methods are specific to the Collection element; all other methods defined by the parent Element class are also available.