Те, кто впервые сталкивается с термином "итерация", как правило обнаруживают в стандартной библиотеке PHP (далее по тексту SPL - Standart PHP Library) огромный список классов, которые имеют отношение к данному понятию. Такой объем информации может отпугнуть новичка, создавая впечатление, что итерация - это что-то из раздела программирования ради самого программирования.
Если вы активно используете PHP, то обязательно сталкиваетесь с обработкой массивов. А обработка массива - это, практически всегда, перебор его элементов. Даже бегло просмотрев на код PHP практически везде можно обнаружить цикл foreach. Итерация - это процесс прохода по списку значений. С ее помощью можно обрабатывать объекты, массивы, директории и даже результат запроса к базе данных.
В первой части серии из двух уроков мы рассмотрим, что такое итерация и какие преимущества есть у классов из SPL. В SPL имеется большое количество различных итераторов, использование которых позволяет создавать более эффективный и легко читаемый код.
Зачем и когда использовать итераторы SPL
Обработка объектов итераторов очень похожа на обработку массивов. Многие начинающие программисты начинают с использования итераторов для массивов. Но реальные преимущества итераторы дают при переборе большого количества гораздо более сложных данных, чем простой массив.
Цикл foreach делает копию массива, который ему передаётся. Если происходит обработка большого объема данных, то копирование массивов при каждом использовании цикла foreach может быть нежелательным. Итераторы SPL инкапсулируют список и делают видимым один элемент в конкретный момент времени, что гораздо эффективнее.
При создании структур данных итераторы могут существенно повлиять на производительность, так как позволяют организовать отложенную загрузку данных. Отложенная загрузка дает возможность получать данные только тогда, когда они нужны. Также можно манипулировать данными (фильтровать, преобразовывать и так далее) перед передачей их пользователю.
Решение об использовании итераторов всегда остаётся за разработчиком. Итераторы имеют ряд преимуществ, но в некоторых случаях их применение может оказаться избыточным (например, для небольших наборов данных). Поэтому нужно принимать во внимание все факторы проекта.
Итерация массивов
Первый итератор, который мы рассмотрим - ArrayIterator. Конструктор принимает массив в качестве параметра и предоставляет набор методов для его обработки. Например:
<?php
// Массив (используем короткую нотацию PHP 5.4)
$arr = ["sitepoint", "phpmaster", "buildmobile", "rubysource",
"designfestival", "cloudspring"];
// Создаем ArrayIterator и передаем ему массив
$iter = new ArrayIterator($arr);
// Цикл для обработки объекта
foreach ($iter as $key => $value) {
echo $key . ": " . $value . "<br>";
}
Код выше приведенного примера выведет:
0: sitepoint
1: phpmaster
2: buildmobile
3: rubysource
4: designfestival
5: cloudspring
Обычно используется ArrayObject, класс для обработки объектов как массивов в определенном контексте, вместо непосредственного применения ArrayIterator. В данном случае автоматически создается ArrayIterator когда используется цикл foreach или можно вызвать метод ArrayIterator::getIterator().
Обратите внимание, что хотя ArrayObject и ArrayIterator ведут себя как массивы в данном контексте, они являются объектами. Попытка использовать встроенные функции для массивов, например, sort() или array_keys(), для них приведет к ошибке.
Использование ArrayIterator ограничивается одномерными массивами. Тогда, когда можно обрабатывать многомерные массивы нужно использовать RecursiveArrayIterator.
Обычный сценарий - связывание циклов foreach или создание рекурсивных функций для провреки всех элементов многомерного массива. Например:
<?php
// Многомерный массив
$arr = [
["sitepoint", "phpmaster"],
["buildmobile", "rubysource"],
["designfestival", "cloudspring"],
"not an array"
];
// Цикл по объекту
foreach ($arr as $key => $value) {
// Проверка на массив
if (is_array($value)) {
foreach ($value as $k => $v) {
echo $k . ": " . $v . "<br>";
}
}
else {
echo $key . ": " . $value . "<br>";
}
}
Вывод пример будет иметь следующий вид:
0: sitepoint
1: phpmaster
0: buildmobile
1: rubysource
0: designfestival
1: cloudspring
3: not an array
Более элегантный подход реализуется с помощью RecursiveArrayIterator.
<?php
...
$iter = new RecursiveArrayIterator($arr);
// Цикл по объекту
// Нужно создать экземпляр RecursiveIteratorIterator
foreach(new RecursiveIteratorIterator($iter) as $key => $value) {
echo $key . ": " . $value . "<br>";
}
Данный код выведет то же, что и предыдущий пример.
Обратите внимание, что нужно создать ему новый экземпляр RecursiveIteratorIterator и передать ему объект RecursiveArrayIterator.
Итератор RecursiveArrayIterator следует использовать при работе с многомерными массивами. RecursiveIteratorIterator является
декоратором, который выполняет всю работу. Он берет RecursiveArrayIterator и проходит по любому элементу Iterable, который найдет. По существу, декоратор "разглаживает" RecursiveArrayIterator. Вы можете определять глубину обработки с помощью вызова RecursiveIteratorIterator::getDepth(). Нужно осторожно применять RecursiveArrayIterator и RecursiveIteratorIterator при работе с объектами. Объекты будут распознаны как Iterable и включены в цикл обработки.
Итерация директорий
Несомненно, что иногда вам приходится обрабатывать директории и их файлы. Существует множество методов для решения подобных задач с помощью встроенных функций PHP, например, scandir() или glob(). Но также можно использовать DirectoryIterator. Даже в своей простой форме DirectoryIterator - достаточно мощный инструмент. Но его можно также расширить.
Пример обработки директории с помощью DirectoryIterator:
<?php
// Создаем новый объект DirectoryIterator
$dir = new DirectoryIterator("/my/directory/path");
// Цикл по содержанию директории
foreach ($dir as $item) {
echo $item . "<br>";
}
Вывод зависит от содержания директории, например, он может быть таким:
..
api
index.php
lib
workspace
Для DirectoryIterator, также как и для многих других итераторов SPL, можно использовать исключения для обработки ошибок.
<?php
try {
$dir = new DirectoryIterator("/non/existent/path");
foreach ($dir as $item) {
echo $item . "<br>";
}
}
catch (Exception $e) {
echo get_class($e) . ": " . $e->getMessage();
}
UnexpectedValueException: DirectoryIterator::__construct(/non/existent/path,/non/existent/path): The system cannot find the file specified. (code: 2)
С помощью набора различных методов, таких как DirectoryIterator::isDot(), DirectoryIterator::getType() и DirectoryIterator::getSize(), можно получить практически любую информацию о директории. Также можно комбинировать DirectoryIterator с FilterIterator или RegexIterator для получения списка файлов по определенным критериям. Например:
<?php
class FileExtensionFilter extends FilterIterator
{
// Белый список расширений файлов
protected $ext = ["php", "txt"];
// Абстрактный метод, который надо реализовать в подклассе
public function accept() {
return in_array($this->getExtension(), $this->ext);
}
}
//Создаем новый итератор
$dir = new FileExtensionFilter(new DirectoryIterator("./"));
...
В SPL также имеется RecursiveDirectoryIterator, который можно использовать также, как и RecursiveArrayIterator. Есть одна особенность. RecursiveDirectoryIterator не возвращает пустых директорий: если директория содержит много поддиректорий, но без файлов, результат будет пустым.
<?php
// Создаем новый объект RecursiveDirectoryIterator
$iter = new RecursiveDirectoryIterator("/my/directory/path");
// Цикл по списку директории
// Нужно создать новый экземпляр RecursiveIteratorIterator
foreach (new RecursiveIteratorIterator($iter) as $item) {
echo $item . "<br>";
}
Примерный вид результата работы кода:
./api/.htaccess
./api/index.php
./index.php
...
SPL предоставляет программисту
большой набор инструментов для организации итераций. Иногда, классы могут показаться излишне обобщенными. В таких случаях можно легко добавить нужный функционал.
Для того, чтобы объект можно было перебирать в цикле foreach, PHP требует, чтобы он был экземпляром Traversable. Вы не можете реализовать данный интерфейс непосредственно (хотя его и можно использовать для проверок instaceof), а нужно будет создавать интерфейс Iterator или IteratorAggregate.
Iterator
Iterator позволяет создавать объекты, которые будут перебираться непосредственно или использоваться другими итераторами. Данный интерфейс имеет пять методов, которые нужно реализовать: rewind(), current(), key(), next(), и valid().
Предположим.. что у нас есть библиотека и мы хотим осуществлять перебор коллекции книг. Ниже приводится пример реализации Iterator:
<?php
class Library implements Iterator
{
// Внутренний указатель на текущую позицию
// в наборе данных
protected $position = 0;
// Массив названий книг в бибилиотеке
protected $books = [
"Professional PHP Programming",
"Programming Perl",
"A Byte of Python",
"The Ruby Way"
];
// Данный метод перемещает указатель назад к началу списка
// для перезапуска перебора
public function rewind() {
echo "rewinding <br>";
$this->position = 0;
}
// this method returns the value at the current
// position of the dataset
public function current() {
echo "current <br>";
return $this->books[$this->position];
}
// Данный метод возвращает текущее значение указателя
public function key() {
echo "key <br>";
return $this->position;
}
// Данный метод перемещает указатель на следующий пункт
// в наборе данных
public function next() {
echo "next <br>";
++$this->position;
}
// Данный метод возвращает логическое значение результата проверки
// соответствия набору данных по текущему указателю
public function valid() {
echo "valid <br>";
return isset($this->books[$this->position]);
}
}
$library = new Library();
foreach ($library as $key => $value) {
echo $key . ": " . $value . "<br>";
}
Результат работы приведенного кода:
rewinding
valid
current
key
0: Professional PHP Programming
next
valid
current
key
1: Programming Perl
next
valid
current
key
2: A Byte of Python
next
valid
current
key
3: The Ruby Way
next
valid
Когда начинается перебор, PHP вызывает метод rewind() для перемещения указателя в начало набора данных. Затем осуществляется проверка правильности данных с помощью метода valid(). Если возвращаемое значение true, то далее вызывается метод current(), чтобы получить значение текущего указателя. Так как запрашивается $key для цикла, то PHP вызывает метод key() для получения текущего значения. PHP затем вызывает метод next() для перемещения указателя и метод valid() для проверки правильности данных. Цикл продолжается до тех пор, пока метод valid() не вернет false.
Iterator дает возможность реализовать практически любой итератор с нуля. Конечно, выше приведенный пример очень простой и предназначен только для демонстрации методов. В идеале, с таким наборами данных лучше использовать IteratorAggregate.
IteratorAggregate
IteratorAggregate требует реализации единственного метода getIterator(). Данный метод требуется для возвращения внешнего итератора, который будет использоваться для перебора. Вот как будет выглядеть выше приведенный пример с использованием IteratorAggregate:
<?php
class Library implements IteratorAggregate
{
protected $books = [
"Professional PHP Programming",
"Programming Perl",
"A Byte of Python",
"The Ruby Way"
];
// Возвращает итератор для данных
public function getIterator() {
echo "getIterator <br>";
return new ArrayIterator($this->books);
}
}
$library = new Library();
foreach($library as $key => $value) {
echo $key . ": " . $value . "<br>";
}
Выше приведенный код выдаст:
getIterator
0: Professional PHP Programming
1: Programming Perl
2: A Byte of Python
3: The Ruby Way
В начале перебора PHP вызывает getIterator(), который возвращает итератор (в данном случае - итератор SPL ArrayIterator). PHP затем выполняет все соответствующие вызовы для итератора.
Оба интерфейса обеспечивают одинаковый функционал, поэтому иногда трудно выбрать Iterator или IteratorAggregate. В общем случае Iterator следует использовать в тех случаях, когда требуется реализовать функционал итератора с нуля, потому что IteratorAggregate не подходит.
Резюме
Создавать собственные итераторы достаточно просто, а SPL предоставляет отличные средства для решения подобных задач.