Class Atk4\Ui\Form\Control\Multiline

`extends`	`Control`

Creates a Multiline field within a table, which allows adding/editing multiple data rows.

Using hasMany reference will required to save reference data using Multiline::saveRows() method.

$form = Form::addTo($app); $form->setModel($invoice, []);

// add Multiline form control and set model for Invoice items $ml = $form->addControl('ml', [Multiline::class]); $ml->setReferenceModel('Items', null, ['item', 'cat', 'qty', 'price', 'total']);

$form->onSubmit(function (Form $form) use ($ml) { // save Form model and then Multiline model $form->model->save(); // saving invoice record $ml->saveRows(); // saving invoice items record related to invoice return new JsToast('Saved!'); });

If Multiline's model contains expressions, these will be evaluated on the fly whenever data gets entered.

Multiline input also has an onChange callback that will return all data rows in an array. It is also possible to fire onChange handler only for certain fields by passing them as an array to the method.

Note that deleting a row will always fire the onChange callback.

You can use the returned data to update other related areas of the form. For example, updating Grand Total field of all invoice items.

$ml->onChange(function (array $rows) use ($form) { $grandTotal = 0; foreach ($rows as $row => $cols) { foreach ($cols as $col) { $fieldName = array_key_first($col); if ($fieldName === 'total') { $grandTotal += $col[$fieldName]; } } }

return $form->js(false, null, 'input[name="grand_total"]')->val($app->uiPersistence->typecastSaveField(new Field(['type' => 'atk4_money']), $grandTotal)); }, ['qty', 'price']);

Finally, it's also possible to use Multiline for quickly adding records to a model. Be aware that in the example below all User records will be displayed. If your model contains a lot of records, you should handle their limit somehow.

$form = Form::addTo($app); $ml = $form->addControl('ml', [Form\Control\Multiline::class]); $ml->setModel($user, ['name', 'is_vip']);

$form->onSubmit(function (Form $form) use ($ml) { $ml->saveRows(); return new JsToast('Saved!'); });

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\Form\Control
    - Atk4\Ui\Form\Control\Multiline

Located at ui/src/Form/Control/Multiline.php

Methods
`protected`	`init(): void` Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Overrides `Atk4\Ui\Form\Control::init()`	#
`protected`	`typeCastLoadValues(array $values): array`	#
`public`	`onLineChange(Closure(mixed, Form): (JsExpressionable\|View\|string\|void) $fx, array $fields): void` Add a callback when fields are changed. You must supply array of fields that will trigger the callback when changed. Add a callback when fields are changed. You must supply array of fields that will trigger the callback when changed.	#
`public`	`getValue(): string` Get Multiline initial field value. Value is based on model set and will output data rows as JSON string value. Get Multiline initial field value. Value is based on model set and will output data rows as JSON string value.	#
`public`	`validate(array $rows): array` Validate each row and return errors if found. Validate each row and return errors if found.	#
`public`	`saveRows(): $this`	#
`protected`	`addModelValidateErrors(array $errors, string $rowId, Model $entity): array` Check for model validate error. Check for model validate error.	#
`private`	`getMlRowId(array $row): ?string` Finds and returns Multiline row ID. Finds and returns Multiline row ID.	#
`public`	`setModel(Model $model, array<int, string>\|null $fields = null): void` Associate this view with a model. Do not place any logic in this class, instead take it to renderView(). Associate this view with a model. Do not place any logic in this class, instead take it to renderView(). Do not try to create your own "Model" implementation, instead you must be looking for your own "Persistence" implementation. Overrides `Atk4\Ui\View::setModel()`	#
`public`	`setReferenceModel(string $refModelName, Model $entity = null, array $fieldNames = []): void` Set hasMany reference model to use with multiline. Set hasMany reference model to use with multiline. Note: When using setReferenceModel you might need to set this corresponding field to neverPersist to true. Otherwise, form will try to save 'multiline' field value as an array when form is save. $multiline = $form->addControl('multiline', [Multiline::class], ['neverPersist' => true])	#
`public`	`getFieldDef(Field $field): array` Return field definition in order to properly render them in Multiline. Return field definition in order to properly render them in Multiline. Multiline uses Vue components in order to manage input type based on field type. Component name and props are determine via the getComponentDefinition function.	#
`protected`	`getSuiTableCellProps(Field $field): array` Each field input, represent by a Vue component, is place within a table cell. Cell properties can be customized via … Each field input, represent by a Vue component, is place within a table cell. Cell properties can be customized via $field->ui['multiline'][Form\Control\Multiline::TABLE_CELL].	#
`protected`	`getSuiInputProps(Field $field): array` Return props for input component. Return props for input component.	#
`protected`	`getDatePickerProps(Field $field): array` Return props for AtkDatePicker component. Return props for AtkDatePicker component.	#
`protected`	`getDropdownProps(Field $field): array` Return props for Dropdown components. Return props for Dropdown components.	#
`protected`	`getLookupProps(Field $field): array` Set property for AtkLookup component. Set property for AtkLookup component.	#
`public`	`setLookupOptionValue(Field $field, string $value): void`	#
`protected`	`getComponentDefinition(Field $field): array` Component definition require at least a name and a props array. Component definition require at least a name and a props array.	#
`protected`	`getFieldItems(Field $field, ?int $limit = 10): array`	#
`protected`	`valuePropsBinding(string $values): void` Apply Props to component that require props based on field value. Apply Props to component that require props based on field value.	#
`protected`	`renderView(): void` View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic… View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic that integrates with Fomantic-UI. Overrides `Atk4\Ui\Form\Control::renderView()`	#
`private`	`outputJson(): void` Render callback according to multi line action. 'update-row' need special formatting. Render callback according to multi line action. 'update-row' need special formatting.	#
`private`	`getCallbackValues(Model $entity): array` Return values associated with callback field. Return values associated with callback field.	#
`private`	`createDummyEntityFromPost(Model $model): Model` Looks inside the POST of the request and loads data into model. Allow to Run expression base on post row value. Looks inside the POST of the request and loads data into model. Allow to Run expression base on post row value.	#
`private`	`getExpressionFields(Model $model): array<string, SqlExpressionField>` Get all field expression in model, but only evaluate expression used in rowFields. Get all field expression in model, but only evaluate expression used in rowFields.	#
`private`	`getExpressionValues(Model $entity): array` Return values associated to field expression. Return values associated to field expression.	#
`private`	`getDummyExpression(SqlExpressionField $exprField, Model $entity): string` Return expression where fields are replace with their current or default value. Ex: total field expression = [qty] * … Return expression where fields are replace with their current or default value. Ex: total field expression = [qty] * [price] will return 4 * 100 where qty and price current value are 4 and 100 respectively.	#
`private`	`getValueForExpression(Field $exprField, string $fieldName, Model $entity): string` Return a value according to field used in expression and the expression type. If field used in expression is null, the… Return a value according to field used in expression and the expression type. If field used in expression is null, the default value is returned.	#

Methods inherited from Atk4\Ui\Form\Control
`set(), renderTemplateToHtml(), onChange(), jsInput()`

Methods inherited from Atk4\Ui\View
`__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()`

Methods inherited from Atk4\Ui\View

__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Constants
`public`	`INPUT = 'SuiInput'`	#
`public`	`READ_ONLY = 'AtkMultilineReadonly'`	#
`public`	`TEXT_AREA = 'AtkMultilineTextarea'`	#
`public`	`SELECT = 'SuiDropdown'`	#
`public`	`DATE = 'AtkDatePicker'`	#
`public`	`LOOKUP = 'AtkLookup'`	#
`public`	`TABLE_CELL = 'SuiTableCell'`	#

Properties
`public`	`HtmlTemplate\|null`	`$multiLineTemplate` The template needed for the multiline view. The template needed for the multiline view.	#
`private`	`View`	`$multiLine` The multiline View. Assigned in init(). The multiline View. Assigned in init().	#
`public`	`array`	`$componentProps = []`	#
`public`	`array`	`$tableProps = []` SuiTable component props SuiTable component props	#
`protected`	`array<string, array<string, mixed>>`	$fieldMapToComponent = [ 'default' => ['component' => self::INPUT, 'componentProps' => [__CLASS__, 'getSuiInputProps']], 'readonly' => ['component' => self::READ_ONLY, 'componentProps' => []], 'textarea' => ['component' => self::TEXT_AREA, 'componentProps' => []], 'select' => ['component' => self::SELECT, 'componentProps' => [__CLASS__, 'getDropdownProps']], 'date' => ['component' => self::DATE, 'componentProps' => [__CLASS__, 'getDatePickerProps']], 'lookup' => ['component' => self::LOOKUP, 'componentProps' => [__CLASS__, 'getLookupProps']], ] Set Vue component to use per field type. Set Vue component to use per field type.	#
`public`	`bool`	`$addOnTab = false` Add row when tabbing out of last column in last row. Add row when tabbing out of last column in last row.	#
`private`	`array`	`$fieldDefs` The definition of each field used in every multiline row. The definition of each field used in every multiline row.	#
`private`	`JsCallback`	`$renderCallback`	#
`protected`	`(Closure(mixed, Form): (JsExpressionable\|View\|string\|void))\|null`	`$onChangeFunction` Function to execute when field change or row is delete. Function to execute when field change or row is delete.	#
`protected`	`array`	`$eventFields` Set fields that will trigger onChange function. Set fields that will trigger onChange function.	#
`private`	`array`	`$rowErrors` Collection of field errors. Collection of field errors.	#
`public`	`array`	`$rowFields` The fields names used in each row. The fields names used in each row.	#
`public`	`array`	`$rowData` The data sent for each row. The data sent for each row.	#
`public`	`int`	`$rowLimit = 0` The max number of records (rows) that can be added to Multiline. 0 means no limit. The max number of records (rows) that can be added to Multiline. 0 means no limit.	#
`public`	`int`	`$itemLimit = 25` The maximum number of items for select type field. The maximum number of items for select type field.	#
`private`	`array<string, Closure(Field, string): void>`	`$valuePropsBinding = []`	#
`public`	`JsFunction`	`$jsAfterAdd`	#
`public`	`JsFunction`	`$jsAfterDelete`	#

Properties inherited from Atk4\Ui\Form\Control
`$form, $entityField, $controlClass, $layoutWrap, $renderLabel, $width, $caption, $hint, $disabled, $readOnly`

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $ui, $class, $style, $attr, $template, $defaultTemplate, $content, $element, $executorFactory, $stickyArgs`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\NameTrait
`$name`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Class Atk4\Ui\Form\Control\Multiline

Overrides

Overrides

Overrides