Skip to content

Remove Multiline "__mlid" early from row data #2301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mvorisek merged 3 commits into from
Oct 19, 2025
Merged

Remove Multiline "__mlid" early from row data #2301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e01c5b
use Reference::isOneToOne
mvorisek Oct 17, 2025
d85debb
refactor - simplify getMlRowId()
mvorisek Oct 17, 2025
f2f6461
refactor - remove mlid early from row data
mvorisek Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions demos/form-control/multiline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@
$controlTotal = $column->addControl('total', ['readOnly' => true])->set($total);

// update total when qty and box value in any row has changed
$multiline->onLineChange(static function (array $rows, Form $form) use ($controlTotal) {
$multiline->onLineChange(static function (array $rows, array $mlids, Form $form) use ($controlTotal) {
$total = 0;
foreach ($rows as $row => $cols) {
foreach ($rows as $cols) {
$total += $cols[MultilineItem::hinting()->fieldName()->qty] * $cols[MultilineItem::hinting()->fieldName()->box];
}

Expand Down
4 changes: 2 additions & 2 deletions docs/multiline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,9 @@ You can return a single JsExpressionable or an array of JsExpressionables which
In this case we display a message when any of the control value for 'qty' and 'box' are changed:

```
$multiline->onLineChange(function (array $rows, Form $form) {
$multiline->onLineChange(function (array $rows, array $mlids, Form $form) {
$total = 0;
foreach ($rows as $row => $cols) {
foreach ($rows as $cols) {
$qty = $cols['qty'] ?? 0;
$box = $cols['box'] ?? 0;
$total += $qty * $box;
Expand Down
107 changes: 45 additions & 62 deletions src/Form/Control/Multiline.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
use Atk4\Data\Field\SqlExpressionField;
use Atk4\Data\Model;
use Atk4\Data\Persistence;
use Atk4\Data\Reference\ContainsOne;
use Atk4\Data\ValidationException;
use Atk4\Ui\Form;
use Atk4\Ui\HtmlTemplate;
Expand Down Expand Up @@ -150,7 +149,7 @@ class Multiline extends Form\Control
/** @var JsCallback */
private $renderCallback;

/** @var \Closure(mixed, Form): (JsExpressionable|View|string|void)|null Function to execute when field change or row is delete. */
/** @var \Closure(list<array<string, mixed>>, list<string>, Form): (JsExpressionable|View|string|void)|null Function to execute when field change or row is delete. */
protected $onChangeFunction;

/** @var list<string> Set fields that will trigger onChange function. */
Expand All @@ -163,7 +162,7 @@ class Multiline extends Form\Control
public $rowFields;

/** @var list<array<string, mixed>> The data sent for each row. */
public $rowData;
protected $rowData;

/** @var int The max number of records (rows) that can be added to Multiline. 0 means no limit. */
public $rowLimit = 0;
Expand Down Expand Up @@ -227,7 +226,7 @@ protected function init(): void
return $jsError;
});

if ($this->isContainsOne()) {
if ($this->isOneToOne()) {
$this->rowLimit = 1;
}
}
Expand All @@ -252,32 +251,26 @@ private function typecastUiSaveValues(array $values): array
}

/**
* @param array<mixed, array<string, string|null>> $values
* @param array<string, string|null> $row
*
* @return array<mixed, array<string, mixed>>
* @return array<string, mixed>
*/
private function typecastUiLoadValues(array $values): array
private function typecastUiLoadRow(array $row): array
{
$res = [];
foreach ($values as $k => $row) {
foreach ($row as $fieldName => $value) {
if ($fieldName === '__atkml') {
$res[$k][$fieldName] = $value;
} else {
$res[$k][$fieldName] = $fieldName === $this->model->idField
? $this->getApp()->uiPersistence->typecastAttributeLoadField($this->model->getField($fieldName), $value)
: $this->getApp()->uiPersistence->typecastLoadField($this->model->getField($fieldName), $value);
}
}
foreach ($row as $fieldName => $value) {
$res[$fieldName] = $fieldName === $this->model->idField
? $this->getApp()->uiPersistence->typecastAttributeLoadField($this->model->getField($fieldName), $value)
: $this->getApp()->uiPersistence->typecastLoadField($this->model->getField($fieldName), $value);
}

return $res;
}

private function isContainsOne(): bool
private function isOneToOne(): bool
{
return $this->entityField->getField()->hasReference()
&& $this->entityField->getField()->getReference() instanceof ContainsOne;
&& $this->entityField->getField()->getReference()->isOneToOne();
}

#[\Override]
Expand Down Expand Up @@ -349,31 +342,45 @@ private function invokeWithContainsXxxNormalizeHookIgnored(\Closure $fx): void
}, null, Model::class)();
}

/**
* @return array{list<array<string, mixed>>, list<string>}
*/
private function decodeInput(string $json): array
{
$rowDataWithMlid = $this->getApp()->decodeJson($json);
$rowData = [];
$mlids = [];
foreach ($rowDataWithMlid as $row) {
$mlids[] = $row['__atkml'];
unset($row['__atkml']);
$rowData[] = $this->typecastUiLoadRow($row);
}

return [$rowData, $mlids];
}

#[\Override]
public function setInputValue(string $value): void
{
$this->rowData = $this->typecastUiLoadValues($this->getApp()->decodeJson($value));
[$rowData, $mlids] = $this->decodeInput($value);

$this->rowData = $rowData;
if ($this->rowData !== []) {
$this->rowErrors = $this->validate($this->rowData);
$this->rowErrors = $this->validate($this->rowData, $mlids);
if ($this->rowErrors !== []) {
throw new ValidationException([$this->shortName => 'Multiline error']);
}
}

$rowsRaw = [];
foreach ($this->rowData as $k => $v) {
unset($v['__atkml']);

$rowsRaw[$k] = $this->typecastContainedSaveRow($v);
}
$rowsRaw = array_map(fn ($v) => $this->typecastContainedSaveRow($v), $this->rowData);

// mimic ContainsOne save format
// https://github.com/atk4/data/blob/6.0.0/src/Reference/ContainsOne.php#L37
// TODO replace with something like "schedule model save task" and then drop self::saveRows() method
if ($rowsRaw === []) {
$value = '';
} else {
foreach ($rowsRaw as $k => $rowRaw) { // @phpstan-ignore foreach.keyOverwrite (https://github.com/phpstan/phpstan-strict-rules/issues/194)
foreach ($rowsRaw as $k => $rowRaw) {
$idFieldRawName = $this->model->getIdField()->getPersistenceName();
if ($rowRaw[$idFieldRawName] === null) {
$refModel = $this->entityField->getField()->hasReference()
Expand All @@ -396,7 +403,7 @@ public function setInputValue(string $value): void
}
}

if ($this->isContainsOne()) {
if ($this->isOneToOne()) {
assert(count($rowsRaw) === 1);
$rowsRaw = array_first($rowsRaw);
}
Expand All @@ -413,8 +420,8 @@ public function setInputValue(string $value): void
* Add a callback when fields are changed. You must supply array of fields
* that will trigger the callback when changed.
*
* @param \Closure(mixed, Form): (JsExpressionable|View|string|void) $fx
* @param list<string> $fields
* @param \Closure(list<array<string, mixed>>, list<string>, Form): (JsExpressionable|View|string|void) $fx
* @param list<string> $fields
*/
public function onLineChange(\Closure $fx, array $fields): void
{
Expand All @@ -427,18 +434,19 @@ public function onLineChange(\Closure $fx, array $fields): void
* Validate each row and return errors if found.
*
* @param list<array<string, mixed>> $rows
* @param list<string> $mlids
*
* @return array<string, list<array{name: string, msg: string}>>
*/
public function validate(array $rows): array
public function validate(array $rows, array $mlids): array
{
$rowErrors = [];
$entity = $this->model->createEntity();

foreach ($rows as $cols) {
$rowId = $this->getMlRowId($cols);
foreach ($rows as $i => $cols) {
$rowId = $mlids[$i];
foreach ($cols as $fieldName => $value) {
if ($fieldName === '__atkml' || $fieldName === $entity->idField) {
if ($fieldName === $entity->idField) {
continue;
}

Expand Down Expand Up @@ -477,10 +485,6 @@ public function saveRows(): self
? $model->load($row[$model->idField])
: $model->createEntity();
foreach ($row as $fieldName => $value) {
if ($fieldName === '__atkml') {
continue;
}

if ($model->getField($fieldName)->isEditable()) {
$entity->set($fieldName, $value);
}
Expand Down Expand Up @@ -513,25 +517,6 @@ protected function addModelValidateErrors(array $errors, string $rowId, Model $e
return $errors;
}

/**
* Finds and returns Multiline row ID.
*
* @param array<string, string> $row
*/
private function getMlRowId(array $row): ?string
{
$rowId = null;
foreach ($row as $col => $value) {
if ($col === '__atkml') {
$rowId = $value;

break;
}
}

return $rowId;
}

/**
* @param list<string>|null $fields
*/
Expand Down Expand Up @@ -831,10 +816,8 @@ private function outputJson(): void
$this->getApp()->terminateJson(['success' => true, 'expressions' => $expressionValues]);
// no break - expression above always terminate
case 'on-change':
$rowsRaw = $this->getApp()->decodeJson($this->getApp()->getRequestPostParam('rows'));
$this->renderCallback->set(function () use ($rowsRaw) {
return ($this->onChangeFunction)($this->typecastUiLoadValues($rowsRaw), $this->form);
});
[$rows, $mlids] = $this->decodeInput($this->getApp()->getRequestPostParam('rows'));
$this->renderCallback->set(fn () => ($this->onChangeFunction)($rows, $mlids, $this->form));
}
}

Expand Down