Collect — PHP: Объектно-ориентированный дизайн

• Fluent Interface
• Query Builder

В PHP большую популярность завоевала библиотека Collect, которая упрощает обработку коллекций и предоставляет огромное количество функций на все случаи жизни. Пример ниже показывает, как выполнить flatten(), используя Collect.

<?php

// Функция collect доступна глобально
// Пакет Collect использует для этого черную магию
$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);

// flatten() «распрямляет» массивы, вытаскивая элементы
// из вложенных массивов на верхний уровень.
$flattened = $collection->flatten();

// Извлечение массива
$flattened->all(); // ['taylor', 'php', 'javascript'];

Всего три строчки, но очень много смысла. Попробуем разобраться. В первой строчке создается объект типа Collection. Создаётся необычным способом — вместо new Collection мы видим обычную функцию. Такой трюк служит одной единственной цели — сделать код компактнее. Это наглядный пример использования паттерна Фабрика.

Объект, который возвращает функция collect(), содержит исходную коллекцию внутри себя и предоставляет свой собственный интерфейс для её изменения. Создав объект, мы можем начать пользоваться самой библиотекой. В примере выше выполняется метод flatten(), который возвращает новую коллекцию. Причем под коллекцией понимается не массив, а именно объект типа Collection, что позволяет продолжить обработку без необходимости повторного оборачивания в collect().

<?php

gettype($collection); // Tightenco\Collect\Support\Collection

Кроме того, практически каждый метод в Collection возвращает новую коллекцию и не модифицирует исходную (но есть некоторые, которые меняют исходную коллекцию). Такой подход позволяет переиспользовать промежуточные результаты, не боясь случайно сломать код. В примере выше это означает, что сама $collection не изменилась. А значит, мы можем её использовать повторно уже для других вычислений.

<?php

$collection = collect(['name' => 'taylor', 'languages' => ['php', 'javascript']]);
$excepted = $collection->except(['name']); // исключаем ключ
$flattened = $collection->flatten();
$collection->all(); // ['name' => 'taylor', 'languages' => ['php', 'javascript']]
$excepted->all(); // ['languages' => ['php', 'javascript']]
$flattened->all(); // ['taylor', 'php', 'javascript']

В последней строчке $flattened->all() из объекта извлекается результирующий массив. Подобный код нужен почти всегда, когда нативная (встроенная в язык) структура оборачивается в объект. Когда все операции выполнены, тогда обычно нам требуется готовый массив для продолжения работы.

Collect содержит внутри себя все те функции высшего порядка, с которыми мы познакомились ранее, это map(), filter() и reduce().

Map:

<?php

$collection = collect([1, 2, 3, 4, 5]);

$multiplied = $collection->map(fn($item) => $item * 2);

$multiplied->all();

// [2, 4, 6, 8, 10]

Filter:

<?php

$collection = collect([1, 2, 3, 4]);

$filtered = $collection->filter(fn($value) => $value > 2);

$filtered->all();

// [3, 4]

Reduce:

<?php

$collection = collect([1, 2, 3]);

$total = $collection->reduce(fn($carry, $item) => $carry + $item);

// 6

Fluent Interface

Посмотрите на то, как организована цепочка вызовов в коде ниже.

<?php

$result = collect(['taylor', 'abigail', null])
    // переводим в верхний регистр
    ->map(fn($name) => strtoupper($name))
    // отфильтровываем пустые
    ->reject(fn($name) => empty($name));

// выводим коллекцию на экран
$result->dump(); // => ['TAYLOR', 'ABIGAIL']

Схематично цепочка выглядит так: $collection->map(...)->reject(...). Мы уже рассматривали подобный код, когда один объект возвращает другой, но тогда речь шла про то, что объект одного типа возвращает объект другого типа, у которого есть свои методы. В данном же примере методы возвращают объект того же типа (возникает ощущение, что возвращается сам объект, но в изменённой форме). В теории такой подход даёт возможность строить цепочки неограниченной длины: $collection->map(...)->map(...)->map(...). Такую цепочку вызовов принято называть fluent interface (текучий интерфейс).

Кстати в том же JavaScript такие цепочки — основной способ строить вычисления на коллекциях.

[0, -2, 4].map(n => n ** 2).filter(n => n > 3); // [4, 16]

Подробнее о том как работает fluent interface – в следующем уроке.

Query Builder

Query Builder — широко распространённый паттерн проектирования, позволяющий собирать сложные запросы по частям. Чаще всего он встречается при работе с базами данных для сбора SQL, либо для коллекций, как в примерах данного урока. Этот паттерн в ОО-языках реализуется с помощью текучего интерфейса (fluent interface).

<?php

// Laravel query builder
$price = DB::table('orders')
                ->where('finalized', 1)
                ->avg('price');

Его удобство проявляется особенно сильно в тех местах, где логика построения запросов условная. Например, фильтрация товаров в интернет-магазине. Без Query Builder такую выборку реализовать крайне трудно.

Дополнительные материалы

1. Сторонняя библиотека или свое решение
2. Документация

---

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты

Об обучении на Хекслете

• Статья «Как учиться и справляться с негативными мыслями»
• Статья «Ловушки обучения»
• Статья «Сложные простые задачи по программированию»
• Вебинар «Как самостоятельно учиться»