feat: HTML Table data keys synchronize order with Heading keys

[rumpfc]

Description
Table is an ideal builder class to turn data and query results into an HTML table. That safes a lot of time to write an own builder.

However there is a weakness when using custom Heading and data (no query results): If the number of headings does not match the number of columns in each row, the table becomes unbalanced. Furthermore when fetching data from APIs or other data sources (i.e. in XML or JSON), data must be manually rearranged to match the correct positions.

This feature introduces method Table::setSyncRowKeysWithHeadingKeys to internally rearrange the positions to match a certain key defined in setHeading if used with an associative array. Data row keys not defined in heading are filtered out, and missing keys in data rows (according to heading) will produce an empty cell.

$table = new \CodeIgniter\View\Table();

$table->setHeading(['name' => 'Name', 'color' => 'Color', 'size' => 'Size'])
    ->setSyncRowKeysWithHeadingKeys(true)
    ->addRow(['color' => 'Blue', 'name' => 'Fred', 'size' => 'Small'])
    ->addRow(['size' => 'Large', 'age' => '24', 'name' => 'Mary'])
    ->addRow(['color' => 'Green']);

echo $table->generate();

This produces HTML table

<table border="0" cellpadding="4" cellspacing="0">
    <thead>
        <tr>
            <th>Name</th>
            <th>Color</th>
            <th>Size</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>Fred</td>
            <td>Blue</td>
            <td>Small</td>
        </tr>
        <tr>
            <td>Mary</td>
            <td></td>
            <td>Large</td>
        </tr>
        <tr>
            <td></td>
            <td>Green</td>
            <td></td>
        </tr>
    </tbody>
</table>

Checklist:

• Securely signed commits
• Component(s) with PHPDoc blocks, only if necessary or adds value
• Unit testing, with >80% coverage
• User guide updated
• Conforms to style guide

[michalsn]

This is a helpful feature. Cool!!!

I have some doubts about the variable/method names you chose - a little too long for my taste. But you don't have to change them right away. I'm looking for others' opinions on this.

[kenjis]

Thank you. This is a great enhancement!

Please add this new feature to the changelog
https://github.com/codeigniter4/CodeIgniter4/blob/4.4/user_guide_src/source/changelogs/v4.4.0.rst#others-1
and link to the description page so that more users will know about it.

See how to link: https://github.com/codeigniter4/CodeIgniter4/blob/develop/contributing/documentation.rst#to-a-section

[paulbalandan]

Is there a need to make this public?

[kenjis]

I think not.

[rumpfc]

All other properties are public, I will keep it for consistency

[kenjis]

All other properties seems to be wrong, but changing them is breaking changes...

[kenjis]

@paulbalandan

1. public for current consistency
2. change only this property to protected or private

[paulbalandan]

I would like this new property to be private to enforce API encapsulation. We can increase visibility later if needed.
For the others, we can retain them as public to prevent breaking changes.

[paulbalandan]

Suggested change

	- **Table:** Addedd ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with heading. See :ref:`table-sync-rows-with-headings` for details.
	- **Table:** Added ``Table::setSyncRowsWithHeading()`` method to synchronize row columns with headings. See :ref:`table-sync-rows-with-headings` for details.

[kenjis]

Thank you for updating.
I commented two minor things inline.

[kenjis]

Thank you!

[michalsn]

Nice work. Thank you.

[kenjis]

@rumpfc Thank you!