Skip to content

Commit

Permalink
Improvements to TableBinding (#397)
Browse files Browse the repository at this point in the history 
* build: upgrade dom requirement and loosen version range

* docs: update examples

* feature: trim whitespace when there are only template children
closes #363

* test: improve alternative table data syntax handling

* test: add failing test for issue #247

* docs: correct output example

* wip: working on normalisation

* wip: massively simplify table data normalisation

* feature: all table binding types are fully tested
closes #247

* maintenance: improve static analysis
  • Loading branch information
@g105b
g105b authored Jan 30, 2023
1 parent ec8babf commit b92a98b
Show file tree
Hide file tree
Showing 6 changed files with 532 additions and 53 deletions.
169 changes: 169 additions & 0 deletions examples/binding/11-bindTable-existingMarkup.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
<?php
use Gt\Dom\HTMLDocument;
use Gt\DomTemplate\DocumentBinder;

require __DIR__ . "/../../vendor/autoload.php";

// EXAMPLE CODE: https://github.com/PhpGt/DomTemplate/wiki/Binding-tables#binding-to-a-table-with-existing-headings

$html = <<<HTML
<!doctype html>
<table>
<thead>
<tr>
<th>Delete</th>
<th data-table-key="id">ID</th>
<th data-table-key="name">Name</th>
<th data-table-key="code">Code</th>
<th>Flag</th>
</tr>
</thead>
<tbody>
<tr data-template>
<td data-bind:class=":deleted">
<form method="post">
<input type="hidden" name="id" data-bind:value="@name" />
<button name="do" value="delete">Delete</button>
</form>
</td>
<td></td>
<td></td>
<td></td>
<td>
<form method="post">
<input type="hidden" name="id" data-bind:value="@name" />
<input name="message" />
<button name="do" value="flag">Flag</button>
<button name="do" value="unflag">Flag</button>
</form>
</td>
</tr>
</tbody>
</table>
HTML;

function example(DocumentBinder $binder):void {
$data = [
"id" => ["9d3407ac", "0f503f80", "032685b1", "eb08fc32"],
"code" => ["A44", "B9", "TX420", "TL29"],
"name" => ["Respiration device N", "Mini filters", "UNG Sponge", "Support Vents"],
"deleted" => [null, "2022-01-26 17:11:00", null, null],
"flagged" => [null, null, null, "out of stock"],
];
$binder->bindTable($data);
}

// END OF EXAMPLE CODE.

$document = new HTMLDocument($html);
$binder = new DocumentBinder($document);
example($binder);
$binder->cleanDatasets();
echo $document;

/* Output:
<!doctype html>
<html>
<head></head>
<body>
<table>
<thead>
<tr>
<th>Delete</th>
<th>ID</th>
<th>Name</th>
<th>Code</th>
<th>Flag</th>
</tr>
</thead>
<tbody id="template-parent-63d2c38f3c39b">
<tr>
<td>
<form method="post">
<input type="hidden" name="id" value="9d3407ac">
<button name="do" value="delete">Delete</button>
</form>
</td>
<td>9d3407ac</td>
<td>Respiration device N</td>
<td>A44</td>
<td>
<form method="post">
<input type="hidden" name="id" value="9d3407ac">
<input name="message">
<button name="do" value="flag">Flag</button>
<button name="do" value="unflag">Flag</button>
</form>
</td>
<td></td>
</tr>
<tr>
<td class="deleted">
<form method="post">
<input type="hidden" name="id" value="0f503f80">
<button name="do" value="delete">Delete</button>
</form>
</td>
<td>0f503f80</td>
<td>Mini filters</td>
<td>B9</td>
<td>
<form method="post">
<input type="hidden" name="id" value="0f503f80">
<input name="message">
<button name="do" value="flag">Flag</button>
<button name="do" value="unflag">Flag</button>
</form>
</td>
<td></td>
</tr>
<tr>
<td>
<form method="post">
<input type="hidden" name="id" value="032685b1">
<button name="do" value="delete">Delete</button>
</form>
</td>
<td>032685b1</td>
<td>UNG Sponge</td>
<td>TX420</td>
<td>
<form method="post">
<input type="hidden" name="id" value="032685b1">
<input name="message">
<button name="do" value="flag">Flag</button>
<button name="do" value="unflag">Flag</button>
</form>
</td>
<td></td>
</tr>
<tr>
<td>
<form method="post">
<input type="hidden" name="id" value="eb08fc32">
<button name="do" value="delete">Delete</button>
</form>
</td>
<td>eb08fc32</td>
<td>Support Vents</td>
<td>TL29</td>
<td>
<form method="post">
<input type="hidden" name="id" value="eb08fc32">
<input name="message">
<button name="do" value="flag">Flag</button>
<button name="do" value="unflag">Flag</button>
</form>
</td>
<td></td>
</tr>
</tbody>
</table>
</body>
</html>
Process finished with exit code 0
*/
2 changes: 1 addition & 1 deletion src/DocumentBinder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public function __construct(
$this->templateCollection = $templateCollection ?? new TemplateCollection($document);
$this->elementBinder = $elementBinder ?? new ElementBinder();
$this->placeholderBinder = $placeholderBinder ?? new PlaceholderBinder();
$this->tableBinder = $tableBinder ?? new TableBinder();
$this->tableBinder = $tableBinder ?? new TableBinder($this->templateCollection);
$this->listBinder = $listBinder ?? new ListBinder($this->templateCollection);
$this->bindableCache = $bindableCache ?? new BindableCache();
}
Expand Down
Loading

0 comments on commit b92a98b

Please sign in to comment.