Funkcje tablicowe: ['array_filter','array_merge'] - Przegląd PHP #1

Rozpoczynam cykl, w którym robię przegląd najbardziej użytecznych funkcji PHP i jak najefektywniej z nich korzystać. Nie ma to jak dobra ściąga przed rozmową kwalifikacyjną. Cykl jest podytkowany tym, że ostatnio w PHP bardzo dużo się zadziało, najnowsze wersje PHP sporo zamieszały, a dobrze jest odświeżyć sobie wiedze i zrobić sobie porządne notatki, nie wspominając już o tym, że trzeba nadgonić!

Przykłady z repozytorium wzięte

Już sama nazwa Funkcje tablicowe powoduje konsternacje. W internecie można napotkać na ogrom przykładów zarówno tych lepszych jak i gorszych. Z funkcji jak korzystać każdy pierwszy junior wie, dlatego postanowiłem zagłębić się w temat trochę głębiej i poszukać ich zastosowania w kilku popularnych frameworkach PHP z którymi miałem styczność w pracy programisty:

Symfony - platforma, która zasługuje na miano najbardziej dojrzałej biznesowo pod względem kompatybilności i przypadków użycia. Na pewno znajdę w środku jakieś ciekawe ćwieki.
Laravel - w przeciwieństwie do Symfony tutaj wszystko zmienia się szybko z wersji na wersje, ale ma to też swoje plusy, bo szybko możemy zbudować prototyp. Gdzie jak nie tam ondajdę naprawdę sporo ciekawych zastosowań funkcji tablicowych.
Rector - Moje ulubione narzędzie do pracy z starym kodem php. Myślę, że może całkiem nieźle pokazać zastosowania funkcji tablicowych.

Przykład z array_filter

Wypłynąłem na otwarty przestwór oceanu kodu php i jak na ironię od razu wpadłem na górę lodową. Pierwszą klasą z brzega była EntityValueResolver implementująca interfejs ValueResolverInterface. Klasa EntityValueResolver jest odpowiedzialna za automatyczne przekazywanie encji do kontrolera na podstawie identyfikatora podanego w ścieżce URL. Przykładowo mogę zdefiniować taki krótki kod:

#[Route('/user/{id}', name: 'user_show')]
public function show(User $user): Response
{
    return new Response('User: ' . $user->getUsername());
}

w którym klasa User jest zmapowaną encją bazodanową i zostanie ona automatycznie poddna procesowi hydracji, i zostanie zwrócona z bazy. Wiecej można poczytać o tym tutaj. Całkiem fajna funkcjonalność!

Jednakże, wracając kolokwialnie rzecz ujmując do “bebechów” i głównego tematu, czyli funkcji tablicowych.

Funkcja array_filter. Użyta w klasie EntityValueResolver

 if ($options->stripNull) {
    $criteria = array_filter($criteria, static fn ($value) => null !== $value);
}

Przykład z Symfony array_filter - pozwala zwrócić nową tablice na podstawie obiektu Closure czyli obiektu funkcji anonimowej zwracjącej wartość true/false dla każdego elementu jak tutaj w przykładzie. Warto zwrócić uwagę, że została ona użyta tutaj jako funkcja statyczna. To jest akurat bardzo ciekawe ponieważ jak czytamy z dokumentacji:

Anonymous functions may be declared statically. This prevents them from having the current class automatically bound to them. Objects may also not be bound to them at runtime.

Dzięki czemu blokowana jest możliwość wykorzystania metody [bindTo]((https://www.php.net/manual/en/closure.bindto.php) z klasy [Closure](Closure. W tym przypadku pojawia się pytanie. Dlaczego powinno się blokować wywołanie metody bindTo dla funkcji anonimowych. Odpowiedzi może być kilka:

a) ponieważ chcemy uniknąć niezamierzonego dostępu do $this w kontekście klasy

b) ponieważ chcemy zwiększyć wydajność i uniknąć potencjalnych wycieków pamięci

c) ponieważ nie chcemy, aby funkcja anonimowa mogła być później przypisana do innego obiektu i zmieniać jego stan dynamicznie

Opcja a) jest tutaj szczególnie istotna. Deklarowanie funkcji anonimowej jako static uniemożliwia jej powiązanie z instancją klasy, co zapobiega przypadkowemu dostępowi do $this. Jest to szczególnie przydatne w przypadku czystych funkcji pure functions, które nie powinny mieć dostępu do stanu obiektu, w którym są wywoływane. Jest to najwidoczniej ukłon w stronę paradygmatów programowania funkcyjnego. Warto też zauważyć, że taki sposób deklaracji podpowiada, że funkcja anonimowa nie ma wpływu na klasę, w której została zadeklarowana i to prawdopodobnie autor miał na myśli! W skrócie to dobra praktyka, ale nie konieczność.

Dodanie static sprawia, że intencja jest jasna “ta funkcja jest niezależna od instancji tej klasy”.

Przykład z array_merge

Funkcja array_merge - dodaje elementy drugiej tablicy do końca pierwszej tablicy w poniższym przykładzie z Symfony

$repository = $manager->getRepository($options->class);
$variables = array_merge($request->attributes->all(), [
    'repository' => $repository,
    'request' => $request,
]);

Dobra, pora sprawdzić, jak można to napisać inaczej:

Destrukturyzacja - zmieniam trochę strukturę, przez co elementy dodane do tablicy z nadpisaniem istniejących wcześniej wartości i usuwa również potrzebę użycia array_merge i zastępuje jej użycie operatora odpakowującego
```
$variables = [
    ...request->attributes->all(),
    'repository' => $repository,
    'request' => $request,
];
```

Bepośrednie przypisanie spowoduje nadpisanie zmiennych

$variables = $request->attributes->all();
$variables['repository'] = $repository;
$variables['request'] = $request;

Użycie operatora union + W tym przypadku zmienne nie zostaną nadpisane

$variables = $request->attributes->all() + [
    'repository' => $repository,
    'request' => $request,
];

#or
$variables += [
    'repository' => $repository,
    'request' => $request,
];

Według mnie destrukturyzacja jest znacznie bardziej kusząca, ale należy uwzględnić parę czynników ubocznych. Operator ... podmieni klucze typu int nawet jak są typu string. W przypadku + klucze zostaną zachowane. Dodatkowo operator ... jest szybszy niż array_merge i wspiera interfejs Traversable a przynajmniej powinien według rfc. Obstawiam więc, że niedługo zobaczymy w kodzie więcej użyć ... zamiast wywołań funkcji array_merge, ale tylko pod jednym warunkiem. Jeżeli klucze tablic nie będą wartości int, bo tylko wtedy array_merge jest szybsze niż ....

Podusmowując:

... resetuje indeksy numeryczne (konwertuje teskty liczbowe na liczby i nadpisuje kolejność), działa szybciej dla nienumerycznych kluczy.
+ zachowuje klucze, ale nie nadpisuje istniejących
array_merge()resetuje indeksy numeryczne podobnie jak ..., ale podobno działa szybciej dla normalnych kluczy numerycznych. Więcej można poczytać o tym tutaj.

Przykłady z repozytorium wzięte

Przykład z array_filter

Przykład z array_merge

Podoba Ci się ten artykuł?