refactor: turn columnSettings data from loose array to value object

[blizzz]

The aim is to make it easier to add properties like read-only or mandatory to user columns. Having the structure in a separate class makes it easier to organize it (no loose array structure flying around), to extend it and also to enforce the structure.

I thought creating a PR for the read-only feature first, but I think it is already a good size for a PR on its own.

[blizzz]

@AIlkiv if you don't mind, I'll fancy your opinion as well.

[enjeck]

I like it!

[AIlkiv]

@blizzz
What do you think about this idea, instead of ViewColumnInformation, create ViewColumnsInformation (or just ViewColumns). Encapsulate all related logic (sorting, decoding, etc.) in this class.

For example instead of:

$decodedValue = \json_decode($value, true);
$value = [];
foreach ($decodedValue as $order => $id) {
	$value[] = [
		'columnId' => $id,
		'order' => $order
	];

Do this:

$value = ViewColumnsInformation::decode($value): ViewColumnsInformation

[blizzz]

Hi @AIlkiv, thank you for the suggestion. I think then I would still leave the ViewColumnInformation as is, really as value for each column. It makes sense to have a collection – leaning on your suggestion – on top that provides this utility methods and can hold the values. I am not sure about the balance between real benefit and another layer though.

[blizzz]

Hi @AIlkiv, thank you for the suggestion. I think then I would still leave the ViewColumnInformation as is, really as value for each column. It makes sense to have a collection – leaning on your suggestion – on top that provides this utility methods and can hold the values. I am not sure about the balance between real benefit and another layer though.

OK, went through, but I did not see that many benefits really. Would keep it as option for the future though (or maybe it is late).

[AIlkiv]

for better readability
order: $index

[AIlkiv]

for better readability
order: $index

[AIlkiv]

json_encode(array_map(function (Column $column, int $index): ViewColumnInformation {
					return new ViewColumnInformation($column->getId(), $index);
				}, array_values($columns), array_keys(array_values($columns))))

It is possible to move these three lines to a new private method

[AIlkiv]

To make the code cleaner (type hints, etc.), it might be better to use a getter/setter. Remove the constants

$a[ViewColumnInformation::KEY_ORDER] - $b[ViewColumnInformation::KEY_ORDER]

VS

$a->getOrder() - $b->getOrder()