0016 - Use variadic to type-hint PHP arrays

[Amoifr]

Questions	Answers
Description?	New ADR for Variadic
Type?	improvement
BC breaks?	no
Deprecations?	no
Fixed ticket?
How to test?
Possible impacts?

[NeOMakinG]

Even if it's PHP and I'm a front-end developer, I have to agree with this, no kind of types like in TS with Array<Products> in PHP?

[Amoifr]

@NeOMakinG The best way is to pass a DTO as a parameter, but this is a workaround if you just have one dimension.

[matks]

Some improvements needed about the text and details but I approve the idea

[matks]

ADR added to README table https://github.com/PrestaShop/ADR/blob/master/README.md

[jolelievre]

I'm in favor of this, although I have a few comments

[jolelievre]

Just a suggestion about redaction, it might be easier to understand if you first display the old way, and then the new way Starting the explanation with the new syntax first, which they may not know, is confusing as you don't have the context If you show the old context first at least people are in their comfort zone ready to accept the new one

[jolelievre]

You only described this as method parameters but I believe it's usable for return as well no? The usage of this new feature will only have its real value if we use them both ways: input and output

[saulaski]

Unfortunately variadic arguments are only used as input. But as output we could use a collection DTO that implements \iterable or \IteratorAggregate interface.

[sowbiba]

It's kind of confusing since, according to your description, this operator can have 2 different meaning depending if it's typed or not, IF I understand well

function f($a, $b, ...$c)
means that you can pass any number of arguments to the function, when it's more than 2, they will be in the variable $c

f(1, 2, $d, $e, $f, $g) => count($c) in the function will give 4

But with function f($a, $b, Product ...$c)

you cannot do f(1, 2, $d, $e, $f, $g) even if $d, $e, $f, $g are Product
but you can do f(1, 2, [$d, $e, $f, $g])

I will look further to PHP documentation

[sowbiba]

It's kind of confusing since, according to your description, this operator can have 2 different meaning depending if it's typed or not, IF I understand well

function f($a, $b, ...$c) means that you can pass any number of arguments to the function, when it's more than 2, they will be in the variable $c

f(1, 2, $d, $e, $f, $g) => count($c) in the function will give 4

But with function f($a, $b, Product ...$c)

you cannot do f(1, 2, $d, $e, $f, $g) even if $d, $e, $f, $g are Product but you can do f(1, 2, [$d, $e, $f, $g])

I will look further to PHP documentation

Or maybe in your 2nd example f(Product ...$products) is not equivalent to f(array $products) ?

[saulaski]

Even if it's PHP and I'm a front-end developer, I have to agree with this, no kind of types like in TS with Array<Products> in PHP?

Not yet unfortunately :/

[saulaski]

In case BC break is an issue, I suggest a simple trick:

public function setItems(array $items): self
{
    $this->items = [];

    return $this->addItem(...$items);
}

protected function addItem(Item ...$items): self
{
    foreach ($items as $item) {
        $this->items[] = $item;
    }

    return $this;
}

[saulaski]

It's kind of confusing since, according to your description, this operator can have 2 different meaning depending if it's typed or not, IF I understand well
function f($a, $b, ...$c) means that you can pass any number of arguments to the function, when it's more than 2, they will be in the variable $c
f(1, 2, $d, $e, $f, $g) => count($c) in the function will give 4
But with function f($a, $b, Product ...$c)
you cannot do f(1, 2, $d, $e, $f, $g) even if $d, $e, $f, $g are Product but you can do f(1, 2, [$d, $e, $f, $g])
I will look further to PHP documentation

Or maybe in your 2nd example f(Product ...$products) is not equivalent to f(array $products) ?

Variadic arguments are always received as an array in the function body. This array contains as many items as variadic arguments provided.
If you need to pass items in an array as variadic arguments, just use the spread operator : f(1, 2, ...$products)

[matks]

Let's try to push this topic this week so what we can vote next week \o/