Form Field Sets

Every Field Group consists of Field Sets that contain Fields. The below covers everything about Field Sets and how they work with Fields.

Usage

When working with Field Sets, you’ll always request it from the Field Group object to request it, initially. Once you have it, you’ll decorate it like everything else. For example:

$form = ee('CP/Form');
$field_group = $form->getGroup('General Settings');
$field_set = $field_group->getFieldSet('Field Set Name');

In the above, $field_set will contain our Field Set object. Once we have it, we can start adding Fields to it as well as set the decorators the surround it.

$field = $field_set->getField('first_name', 'text');

It’s important to note that while Field Sets are built to contain multiple Fields per Set, in most cases you’ll find a single Field suffices.

API Reference

class ExpressionEngine\Library\Cp\Form\Set

toArray()

Returns the entire Cp\Form\Set object into an array. Note that all child elements are converted to an array as well.

getField($name, $type = '')

Will return the Field Group if it exists, or prepare and return a new Field Group. See Field for more details.

removeField($name)

Removes the specified Field Set from the Form Group

withButton($text, $rel = '', $for = '')

Adds a single Button to the Field Set.

withOutButton()

Removes the button from the Field Set

setTitle($title)

The Title element to use for your Field Set (title). Defaults to the $name value if not set.

getTitle()

Returns the title (title)

setDesc($desc)

The Description element to use for your Field Set (desc).

getDesc()

Returns the Field Set Description (desc)

setDescCont($desc_cont)

The Continued Description element to use for your Field Set (desc_cont).

getDescCont()

Returns the Field Set Continued Description (desc_cont)

setExample($example)

The Continued Description element to use for your Field Set (example).

getExample()

Returns the Field Set Example (example)

setExample($example)

The Continued Description element to use for your Field Set (example).

getExample()

Returns the Field Set Example (example)

withGrid()

Sets the Field Set as being used for Grid (there’s some magic that has to happen).

withoutGrid()

Will remove the Field Set as being used by Grid.

---

ExpressionEngine 6 Docs
©2002–2024 Packet Tide,LLC. Edit this page