Skip to content

Add Model support for TreeItemSelector control source data #2023

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

Draft
wants to merge 15 commits into
base: develop
Choose a base branch
from
Draft

Add Model support for TreeItemSelector control source data #2023

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
cb6fb64
Model support for TreeItemSelector for treeItems
mkrecek234 Mar 20, 2023
e160b21
Fix CS
mkrecek234 Mar 20, 2023
d0742d6
Fix phpstan
mkrecek234 Mar 20, 2023
b42a49c
Fix
mkrecek234 Mar 20, 2023
4fe23b7
Fix phpstan
mkrecek234 Mar 20, 2023
06a821e
Fix CS, improved demo
mkrecek234 Mar 20, 2023
416abe6
Fix
mkrecek234 Mar 20, 2023
09bc291
Fix
mkrecek234 Mar 22, 2023
fb7a1a8
Improved data handling without materialization
mkrecek234 Mar 22, 2023
17306b9
Fix CS
mkrecek234 Mar 22, 2023
faf1f8a
Generated phpdoc
mkrecek234 Mar 22, 2023
590bbc6
Simplify and speed up
mkrecek234 Mar 22, 2023
63d04a6
Fix
mkrecek234 Mar 23, 2023
7024eb2
Fix CS
mkrecek234 Mar 23, 2023
d54c7ee
Merge branch 'develop'
mvorisek May 30, 2023
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
7 changes: 7 additions & 0 deletions demos/form-control/tree-item-selector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@
$control = $form->addControl('tree1', [Form\Control\TreeItemSelector::class, 'treeItems' => $items, 'allowMultiple' => false, 'caption' => 'Single selection:']);
$control->set(502);

$model = new File($app->db);
$control = $form->addControl('tree2', [Form\Control\TreeItemSelector::class, 'allowMultiple' => false, 'caption' => 'Selection from tree in Atk4/Model:',
'parentIdField' => $model->fieldName()->parent_folder_id]);

$control->setModel($model);

// $control->onItem(function (int $value) {
// return new JsToast('Received ' . $value);
// });
Expand All @@ -58,6 +64,7 @@
$response = [
'multiple' => $form->model->get('tree'),
'single' => $form->model->get('tree1'),
'model' => $form->model->get('tree2'),
];

$view = new Message('Items: ');
Expand Down
38 changes: 38 additions & 0 deletions src/Form/Control/TreeItemSelector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Atk4\Ui\Form\Control;

use Atk4\Data\Model;
use Atk4\Ui\Form;
use Atk4\Ui\HtmlTemplate;
use Atk4\Ui\Js\Jquery;
Expand Down Expand Up @@ -39,6 +40,13 @@ class TreeItemSelector extends Form\Control
*/
public $loaderCssName = 'atk-tree-loader';

/**
* The field name which includes the parent node's id.
*
* @var string
*/
public $parentIdField = 'parent_id';

/** @var bool Allow multiple selection or just one. */
public $allowMultiple = true;

Expand Down Expand Up @@ -112,6 +120,36 @@ public function setTreeItems(array $treeItems)
return $this;
}

/**
* @param mixed $parentId
*/
protected function addNodes(Model $model, $parentId = null): array
{
$result = [];

$nodeModel = (clone $model)->addCondition($this->parentIdField, $parentId);

foreach ($nodeModel as $node) {
Copy link
Member

@mvorisek mvorisek May 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This implies a DB query (Model::getIterator() which implies SELECT). Recursively.

Single query recursive data fetch can be hard to implement and will require RECURSIVE CTE.

A good enough compromise might be to fetch +1 tree level collectively at once instead of 1 leaf at each time.

Copy link
Contributor Author

@mkrecek234 mkrecek234 May 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mvorisek Recursive CTE is an overkill for such a simple task. Or shall I import the whole tree definition table into an array, and do the recursive operation inside the array? That would speed it up as well, and we talk about reasonably sized trees typically (otherwise we would need another treeview component which dynamically loads sub-trees upon click, there are only few Vue components doing this beautifully). Materializing the whole table into an array, I did before to speed up the script, but you did not like it.

Copy link
Member

@mvorisek mvorisek May 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It it obvious both extremes - current dummy impl. and whole table materialization is not a solution. The later case can produce OOM error easily, imagine the perf. on table with millions of records. It would be good to impl. recursive iterator in atk4/data Model and use it here.

Copy link
Contributor Author

@mkrecek234 mkrecek234 Jun 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think your worries are not realistic, as models for this TreeItemSelector are never tables of million entries. And if they are TreeItem is the wrong control as written before: you would need a Tree Control which dynamically loads sub-trees on clicks. As said, Recursive CTE is an overkill for this simple control, unless you see yourself in a position to implement this soon. Even with recursive CTE, the control would not load properly in time with your million-entries example. Otherwise I suggest we go for the faster export variant. Working well in real life with a few hundreds entries.

Copy link
Member

@mvorisek mvorisek Jun 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Michael, let's focus on the solution and please reread my posts above. I did not written CTE is needed, I have written the current demo is awfully slow, which is a fact and I hope we both understand the PR cannot be merged as is.

I can also tell that table with millions of records is a realistic usecase, not for display, but imagine any tree features per some item like product. No product will have a lot of features, but the whole table can be huge. And as long as you cannot resolve the "minimal spanning tree" in one query, you cannot fetch the data using a single query.

if ($node->get($this->parentIdField) === $parentId) {
Copy link
Member

@mvorisek mvorisek Mar 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this cond?

Copy link
Contributor Author

@mkrecek234 mkrecek234 Mar 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we have to set a new parentId condition on an unconditioned model, otherwise will have contradictory conditions

$newNode = [];
$newNode['name'] = $node->getTitle();
$newNode['id'] = $node->getId();
$newNode['parent_id'] = $node->get($this->parentIdField);
$newNode['nodes'] = $this->addNodes(clone $model, $node->getId());
Copy link
Member

@mvorisek mvorisek Mar 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why to clone here?

Copy link
Contributor Author

@mkrecek234 mkrecek234 Mar 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we have to set a new parentId condition on an unconditioned model, otherwise will have contradictory conditions

Copy link
Contributor Author

@mkrecek234 mkrecek234 Mar 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct myself - this clone is indeed not needed, as we clone earlier into nodeModel already. Correct in latest commit

$result[] = $newNode;
}
}

return $result;
}

public function setModel(Model $model): void
{
parent::setModel($model);

$this->treeItems = $this->addNodes($model);
}

/**
* Returns <input ...> tag.
*
Expand Down