Form Fields

action_button

class ExpressionEngine\Library\CP\Form\Fields\ActionButton

Adds a “pretty” button style link to your form.

checkbox

class ExpressionEngine\Library\CP\Form\Fields\Checkbox

Adds a specialized widget for checkbox

dropdown

class ExpressionEngine\Library\CP\Form\Fields\Dropdown

Adds a fancy select input field especially useful for large data sets to choose from.

file

class ExpressionEngine\Library\CP\Form\Fields\File

Adds a traditional file HTML field to your form.

file-picker

class ExpressionEngine\Library\CP\Form\Fields\FilePicker

Adds a File Picker widget to your shared form

grid

class ExpressionEngine\Library\CP\Form\Fields\Grid

Allows for a more streamlined implementation of Grid within Shared Forms. Two important differences with this implementation is a simpler API and direct handling of POST values.

Note that the Grid Field inherits from the Table Field; as such there’s really only a single method.

$grid = $field_set->getField('my_grid_field', 'grid');

$grid->setOptions([
    'field_name' => $grid->getName(),
    'reorder'    => true,
]);

$grid->setColumns([
    'text example' => ['sort' => false],
    'select example' => ['sort' => false],
    'password example' => ['sort' => false],
    'checkbox example' => ['sort' => false],
    'textarea example' => ['sort' => false],
    'upload example' => ['sort' => false],
]);

$options = ['foo' => 'Foo', 'bar' => 'Bar'];
$cols = [
    ['name' => 'foo-text', 'type' => 'text', 'value' => ''],
    ['name' => 'barr-select', 'type' => 'select', 'value' => '', 'choices' => $options],
    ['name' => 'foo-password', 'type' => 'password', 'value' => ''],
    ['name' => 'bar-checkbox', 'type' => 'checkbox', 'value' => 1],
    ['name' => 'foo-textarea', 'type' => 'textarea', 'value' => '', 'cols' => 2, 'rows' => 5],
    ['name' => 'bar-upload', 'type' => 'file', 'value' => '', 'cols' => 2, 'rows' => 5],
];
$grid->defineRow($cols);
$grid->setData([
    ['foo-text' => 'bar', 'barr-select' => 'foo', 'foo-password' => 'fdsa', 'bar-checkbox' => 1, 'foo-textarea' => '', 'bar-upload' => ''],
    ['foo-text' => 'fdsafdsa', 'barr-select' => 'bar', 'foo-password' => 'fdsa', 'bar-checkbox' => true, 'foo-textarea' => '', 'bar-upload' => '']
]);

$grid->setNoResultsText(sprintf(lang('no_found'), lang('table-thing')), 'add');
$grid->setBaseUrl( ee('CP/URL')->make($this->base_url ));

hidden

class ExpressionEngine\Library\CP\Form\Fields\Hidden

Adds a hidden field to your form

html

class ExpressionEngine\Library\CP\Form\Fields\Html

Allows for putting raw (unformatted) HTML inside your form

multiselect

class ExpressionEngine\Library\CP\Form\Fields\Multiselect

Deploys a series of select input fields together

password

class ExpressionEngine\Library\CP\Form\Fields\Password

Adds your run of the mill password input field wrapped in magic that puts an eye next to it.

radio

class ExpressionEngine\Library\CP\Form\Fields\Radio

This behaves just like checkbox with the exception of being scalar so uses a scalar for the value. See checkbox for details.

select

class ExpressionEngine\Library\CP\Form\Fields\Select

Adds a traditional select input field to your form.

short-text

class ExpressionEngine\Library\CP\Form\Fields\ShortText

Adds a small input HTML field wrapped in a div with flex-input as the class. Useful for stacking fields horizontally.

slider

class ExpressionEngine\Library\CP\Form\Fields\Slider

Puts a slider widget into your form

table

class ExpressionEngine\Library\CP\Form\Fields\Table

Allows for a more streamlined implementation of tables within Shared Forms

$table = $field_set->getField('my_table', 'table');

$table->setOptions([
    'lang_cols' => true,
    'class' => 'product_channels'
]);

$table->setColumns([
    'details' => ['sort' => false],
    'value' => ['sort' => false],
]);

$table->setNoResultsText(sprintf(lang('no_found'), lang('product_channels')));
$table->setBaseUrl( ee('CP/URL')->make($this->base_url ));
$data = [];
$data[] = [
    'Hello',
    'You',
];

$table->setData($data);
$table->addRow([
    'No, Hello',
    'To You!',
]);

text

class ExpressionEngine\Library\CP\Form\Fields\Text

Adds a traditional input HTML field

textarea

class ExpressionEngine\Library\CP\Form\Fields\Textarea

Adds a full textarea input field

toggle

class ExpressionEngine\Library\CP\Form\Fields\Toggle

Adds a Toggle binary toggle

yes_no

class ExpressionEngine\Library\CP\Form\Fields\YesNo

Adds a Toggle control that returns either y or n respectively.

params($params)

A key=>value array of parameters to be chained into a string internally

Example

Here’s a simple example building both number and color Input Fields.

$field_set = $field_group->getFieldSet('color');
$field_set->getField('my_color_field', 'color')->setValue('#C86565');

$field_set = $field_group->getFieldSet('number');
$field_set->getField('my_number_field', 'number')->params(['min' => 100, 'max' => 1000])->setRequired(true);

toArray()

Returns the entire CP\Form\Field object into an array.

getName()

Returns the name used upon creation for the Field.

setClass($class)

The class property to apply to the Field (class).

getClass()

Returns the class property (class)

withMarginTop()

The class margin_top is added to your input element.

withOutMarginTop()

Removes the margin_top from your input

withMarginLeft()

The class margin_left is added to your input element.

withOutMarginLeft()

Removes the margin_left from your input

setNote($note)

The string you want to use for your Note (note).

getNote()

Returns the note string (note)

setAttrs($attrs)

Any custom input parameters you want to attach to your Field (attrs).

getAttrs()

Returns the attributes string (attrs)

setDisabled($disabled)

Whether the Field should be editable (disabled).

getDisabled()

Whether the Field is disabled (disabled)

setValue($value)

The value to use for the “value” parameter (value).

getValue()

The value to use on the Field (value)

setGroup($group)

The group you want to relate this Field to (group).

getGroup()

The group this Field is related to (group)

setGroupToggle($group_toggle)

The group toggle you want to relate this Field to (group_toggle).

getGroupToggle()

The group toggle this Field controls (group_toggle)

setRequired($required)

Whether the field can accept input/editing (required).

getRequired()

Whether this Field is required (required)

setPlaceholder($required)

The string to use for the input “placeholder” attribute (placeholder).

getPlaceholder()

Whether this Field is required (placeholder)

withNoResults($text, $link_text, $link_href)

Used to define quick links when choices are empty.

withOutNoResults()

Will remove the set no results details

setChoices($value)

A simple key=>value array pair to populate options (choices).

getChoices()

The value to use on the Field (choices)

setEncode($encode)

Whether to format text so that it can be safely placed in a form field in the event it has HTML tags (encode).

getEncode()

Whether this Field is encoded (encode)

setDisabledChoices($disabled_choices)

A list of keys used in the options array to prevent selection (disabled_choices).

getDisabledChoices()

The set disabled choices (disabled_choices)

setEmptyText($disabled_choices)

The text to display if there are no options (empty_text).

getEmptyText()

The set text to display (empty_text)