NAME

HTML::FormHandler::Field::Repeatable - Repeatable (array) field

SYNOPSIS

In a form, for an array of hashrefs, equivalent to a 'has_many' database relationship.

has_field 'addresses' => ( type => 'Repeatable' );
has_field 'addresses.address_id' => ( type => 'PrimaryKey' );
has_field 'addresses.street';
has_field 'addresses.city';
has_field 'addresses.state';

For a database field include a PrimaryKey hidden field, or set 'auto_id' to have an 'id' field automatically created.

In a form, for an array of single fields (not directly equivalent to a database relationship) use the 'contains' pseudo field name:

has_field 'tags' => ( type => 'Repeatable' );
has_field 'tags.contains' => ( type => 'Text',
     apply => [ { check => ['perl', 'programming', 'linux', 'internet'],
                  message => 'Not a valid tag' } ]
);

or use 'contains' withsingle fields which are compound fields:

has_field 'addresses' => ( type => 'Repeatable' );
has_field 'addresses.contains' => ( type => '+MyAddress' );

If the MyAddress field contains fields 'address_id', 'street', 'city', and 'state', then this syntax is functionally equivalent to the first method where the fields are declared with dots ('addresses.city');

DESCRIPTION

This class represents an array. It can either be an array of hashrefs (compound fields) or an array of single fields.

The 'contains' keyword is used for elements that do not have names because they are not hash elements.

This field node will build arrays of fields from the the parameters or an initial object, or empty fields for an empty form.

The name of the element fields will be an array index, starting with 0. Therefore the first array element can be accessed with:

$form->field('tags')->field('0')
$form->field('addresses')->field('0)->field('city')

or using the shortcut form:

$form->field('tags.0')
$form->field('addresses.0.city')

ATTRIBUTES

index

This attribute contains the next index number available to create an additional an additional array element.

num_when_empty

This attribute (default 1) indicates how many empty fields to present in an empty form which hasn't been filled from parameters or database rows.

auto_id

Will create an 'id' field automatically