RecursiveIteratorIteratorце конкретна Iteratorреалізація обходу дерева . Це дозволяє програмісту пройти об’єм контейнера, що реалізує RecursiveIteratorінтерфейс, див. Ітератор у Вікіпедії щодо загальних принципів, типів, семантики та зразків ітераторів.
На відміну від того, IteratorIteratorякий конкретний Iteratorваріант обходу об’єкта реалізується в лінійному порядку (і за замовчуванням приймає будь-який тип Traversableу своєму конструкторі), RecursiveIteratorIteratorдозволяє циклічний перегляд усіх вузлів в упорядкованому дереві об’єктів, а його конструктор приймає a RecursiveIterator.
Коротше кажучи: RecursiveIteratorIteratorдозволяє циклічно перебирати дерево, IteratorIteratorдозволяє циклічно перебирати список. Я показую це на деяких прикладах коду нижче.
Технічно це працює шляхом виходу з лінійності шляхом обходу всіх дочірніх вузлів (якщо такі є). Це можливо, оскільки за визначенням усі дочірні вузли знову є a RecursiveIterator. Потім верхній рівень Iteratorвнутрішньо складає різні RecursiveIterators за їх глибиною і зберігає вказівник на поточну активну підгрупу Iteratorдля обходу.
Це дозволяє відвідувати всі вузли дерева.
Основні принципи такі ж, як і у IteratorIterator: Інтерфейс визначає тип ітерації, а базовий клас ітератора - реалізація цієї семантики. Порівняйте з прикладами нижче, для лінійного циклу foreachви зазвичай не задумуєтесь над деталями реалізації, якщо вам не потрібно визначити нове Iterator(наприклад, коли якийсь конкретний тип сам не реалізує Traversable).
Для рекурсивного обходу - якщо ви не використовуєте заздалегідь визначене, Traversalяке вже має ітерацію рекурсивного обходу - вам, як правило, потрібно створити інстанцію існуючої RecursiveIteratorIteratorітерації або навіть написати ітерацію рекурсивного обходу, яка є Traversableвласною, щоб мати такий тип ітерації обходу foreach.
Порада: Ви, мабуть, не реалізовували ні те, ні друге, так що, можливо, варто зробити щось для свого практичного досвіду відмінностей, які вони мають. У кінці відповіді ви знайдете пропозицію "Зроби сам".
Технічні відмінності коротше:
- Хоча
IteratorIteratorприймає будь-який Traversableдля лінійного обходу, RecursiveIteratorIteratorпотрібен більш конкретний RecursiveIteratorцикл по дереву.
- Там, де
IteratorIteratorвиставляється його основний Iteratorза допомогою getInnerIerator(), RecursiveIteratorIteratorнадається поточний активний суб- Iteratorлише за допомогою цього методу.
- Хоча
IteratorIteratorвін абсолютно не знає нічого подібного до батьків чи дітей, але RecursiveIteratorIteratorзнає, як дістати і подорожувати дітей.
IteratorIteratorне потребує стеку ітераторів, RecursiveIteratorIteratorмає такий стек і знає активний підітератор.- Там, де
IteratorIteratorє порядок через лінійність і немає вибору, RecursiveIteratorIteratorє вибір для подальшого обходу, і він повинен приймати рішення для кожного вузла (вирішується через режим perRecursiveIteratorIterator ).
RecursiveIteratorIteratorмає більше методів, ніж IteratorIterator.
Підсумовуючи: RecursiveIteratorце конкретний тип ітерації (зациклювання над деревом), яка працює на власних ітераторах, а саме RecursiveIterator. Це той самий основний принцип, що і в IteratorIerator, але тип ітерації різний (лінійний порядок).
В ідеалі ви також можете створити свій власний набір. Єдине, що потрібно, це те, що ваш ітератор реалізує, Traversableщо можливо через Iteratorабо IteratorAggregate. Тоді ви можете використовувати його з foreach. Наприклад, якийсь об’ємний рекурсивний ітераційний обхід тривимірного дерева разом із відповідним інтерфейсом ітерації для об’єкта (ів) контейнера.
Давайте розглянемо кілька реальних прикладів, які не є такими абстрактними. Між інтерфейсами, конкретними ітераторами, об’єктами контейнера та семантикою ітерацій це, можливо, не така вже й погана ідея.
Візьмемо для прикладу список каталогів. Вважаємо, що на диску є такий файл та дерево каталогів:
У той час як ітератор з лінійним порядком просто перетинає папку та файли верхнього рівня (єдиний список каталогів), рекурсивний ітератор також проходить по вкладеним папкам та перераховує всі папки та файли (перелік каталогів зі списками його підкаталогів):
Non-Recursive Recursive
============= =========
[tree] [tree]
├ dirA ├ dirA
└ fileA │ ├ dirB
│ │ └ fileD
│ ├ fileB
│ └ fileC
└ fileA
Ви можете легко порівняти це з тим, IteratorIteratorщо не має рекурсії для обходу дерева каталогів. І те, RecursiveIteratorIteratorщо може перейти в дерево, як показує Рекурсивний перелік.
Спочатку дуже простий приклад з мікросхемою DirectoryIterator, який реалізує Traversableякий дозволяє foreachдля ітерації над ним:
$path = 'tree';
$dir = new DirectoryIterator($path);
echo "[$path]\n";
foreach ($dir as $file) {
echo " ├ $file\n";
}
Зразковий результат для наведеної вище структури каталогів:
[tree]
├ .
├ ..
├ dirA
├ fileA
Як бачите, це ще не використовується IteratorIteratorабо RecursiveIteratorIterator. Натомість це просто використання лише того, foreachщо працює на Traversableінтерфейсі.
Оскільки foreachза замовчуванням тип ітерації відомий лише з іменем лінійний порядок, ми можемо захотіти вказати тип ітерації явно. На перший погляд це може здатися занадто багатослівним, але для демонстраційних цілей (і щоб зробити різницю RecursiveIteratorIteratorбільш помітною пізніше), давайте вкажемо лінійний тип ітерації, явно вказуючи IteratorIteratorтип ітерації для списку каталогів:
$files = new IteratorIterator($dir);
echo "[$path]\n";
foreach ($files as $file) {
echo " ├ $file\n";
}
Цей приклад майже ідентичний першому, різниця полягає в тому, що $filesзараз це IteratorIteratorтип ітерації для Traversable $dir:
$files = new IteratorIterator($dir);
Як зазвичай акт ітерації виконують foreach:
foreach ($files as $file) {
Вихід абсолютно однаковий. То що різниться? Різним є об’єкт, який використовується в foreach. У першому прикладі це - DirectoryIteratorу другому прикладі це IteratorIterator. Це показує гнучкість ітераторів: Ви можете замінити їх один з одним, код всередині foreachпросто продовжує працювати, як очікувалося.
Почнемо отримувати весь перелік, включаючи підкаталоги.
Оскільки ми зараз визначили тип ітерації, давайте розглянемо можливість змінити її на інший тип ітерації.
Ми знаємо, що нам потрібно обійти все дерево зараз, а не лише перший рівень. Для того, щоб мати цю роботу з простим foreachнам потрібен інший тип ітератора: RecursiveIteratorIterator. І це можна переглядати лише над об'єктами-контейнерами, які мають RecursiveIteratorінтерфейс .
Інтерфейс - це контракт. Будь-який клас, який його реалізує, може бути використаний разом із RecursiveIteratorIterator. Прикладом такого класу є RecursiveDirectoryIterator, який є чимось на зразок рекурсивного варіанту DirectoryIterator.
Давайте побачимо перший приклад коду перед тим, як писати будь-яке інше речення з I-словом:
$dir = new RecursiveDirectoryIterator($path);
echo "[$path]\n";
foreach ($dir as $file) {
echo " ├ $file\n";
}
Цей третій приклад майже ідентичний першому, однак він створює різні результати:
[tree]
├ tree\.
├ tree\..
├ tree\dirA
├ tree\fileA
Гаразд, не те що інше, назва файлу тепер містить назву шляху спереду, але решта також схожа.
Як показує приклад, навіть об'єкт каталогу вже реалізує RecursiveIteratorінтерфейс, цього ще недостатньо, щоб зробити foreachобхід всього дерева каталогів. Тут тут RecursiveIteratorIteratorвступає в дію. Приклад 4 показує, як:
$files = new RecursiveIteratorIterator($dir);
echo "[$path]\n";
foreach ($files as $file) {
echo " ├ $file\n";
}
Використання RecursiveIteratorIteratorзамість попереднього $dirоб'єкта дозволить здійснити foreachобхід усіх файлів та каталогів рекурсивно. Потім перераховуються всі файли, оскільки зараз вказано тип ітерації об’єкта:
[tree]
├ tree\.
├ tree\..
├ tree\dirA\.
├ tree\dirA\..
├ tree\dirA\dirB\.
├ tree\dirA\dirB\..
├ tree\dirA\dirB\fileD
├ tree\dirA\fileB
├ tree\dirA\fileC
├ tree\fileA
Це вже повинно продемонструвати різницю між рівниною та обходом дерева. Можливий RecursiveIteratorIteratorперехід до будь-якої деревоподібної структури як списку елементів. Оскільки інформації є більше (наприклад, про рівень ітерації, що має місце в даний час), можна отримати доступ до об’єкта ітератора під час ітерації по ньому і, наприклад, зробити відступ на виході:
echo "[$path]\n";
foreach ($files as $file) {
$indent = str_repeat(' ', $files->getDepth());
echo $indent, " ├ $file\n";
}
І результат прикладу 5 :
[tree]
├ tree\.
├ tree\..
├ tree\dirA\.
├ tree\dirA\..
├ tree\dirA\dirB\.
├ tree\dirA\dirB\..
├ tree\dirA\dirB\fileD
├ tree\dirA\fileB
├ tree\dirA\fileC
├ tree\fileA
Звичайно, це не виграє конкурс краси, але це показує, що з рекурсивним ітератором доступна більше інформації, ніж просто лінійний порядок ключа та значення . Навіть foreachможе виражати лише такий вид лінійності, доступ до самого ітератора дозволяє отримати більше інформації.
Подібно до метаінформації, існують також різні способи обходу дерева і, отже, порядок виводу. Це режим зRecursiveIteratorIterator і він може бути встановлений за допомогою конструктора.
Наступний приклад покаже, RecursiveDirectoryIteratorщоб видалити крапкові записи ( .і ..), оскільки вони нам не потрібні. Але також буде змінено режим рекурсії, щоб взяти батьківський елемент (підкаталог) першим ( SELF_FIRST) перед дочірніми (файли та підкаталоги в підкаталозі):
$dir = new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS);
$files = new RecursiveIteratorIterator($dir, RecursiveIteratorIterator::SELF_FIRST);
echo "[$path]\n";
foreach ($files as $file) {
$indent = str_repeat(' ', $files->getDepth());
echo $indent, " ├ $file\n";
}
Вихідні дані тепер показують належним чином перелічені записи підкаталогу, якщо порівняти з попередніми вихідними даними, їх там не було:
[tree]
├ tree\dirA
├ tree\dirA\dirB
├ tree\dirA\dirB\fileD
├ tree\dirA\fileB
├ tree\dirA\fileC
├ tree\fileA
Таким чином, режим рекурсії контролює, що і коли повертається фішка або лист у дереві, для прикладу каталогу:
LEAVES_ONLY (за замовчуванням): лише файли зі списком, без каталогів.SELF_FIRST (вгорі): Каталог списку, а потім файли там.CHILD_FIRST (без прикладу): Спочатку перелічіть файли у підкаталозі, а потім каталог.
Вихід з прикладу 5 з двома іншими режимами:
LEAVES_ONLY CHILD_FIRST
[tree] [tree]
├ tree\dirA\dirB\fileD ├ tree\dirA\dirB\fileD
├ tree\dirA\fileB ├ tree\dirA\dirB
├ tree\dirA\fileC ├ tree\dirA\fileB
├ tree\fileA ├ tree\dirA\fileC
├ tree\dirA
├ tree\fileA
Порівнюючи це зі стандартним обходом, усі ці речі недоступні. Тому рекурсивна ітерація дещо складніша, коли вам потрібно обернути її головою, однак вона проста у використанні, оскільки вона поводиться так само, як ітератор, ви вводите її в foreachі готово.
Думаю, цього достатньо прикладів для однієї відповіді. Ви можете знайти повний вихідний код, а також приклад для відображення красивих дерев ascii в цьому суть: https://gist.github.com/3599532
Зроби сам: склади RecursiveTreeIteratorробочий рядок за рядком.
Приклад 5 продемонстрував, що доступна метаінформація про стан ітератора. Однак це було цілеспрямовано продемонстровано в рамках foreachітерації. У реальному житті це природно належить всередині RecursiveIterator.
Кращим прикладом є RecursiveTreeIterator, він піклується про відступ, префікс тощо. Дивіться такий фрагмент коду:
$dir = new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS);
$lines = new RecursiveTreeIterator($dir);
$unicodeTreePrefix($lines);
echo "[$path]\n", implode("\n", iterator_to_array($lines));
RecursiveTreeIteratorПризначений для роботи лінії по лінії, вихід досить прямо вперед з однією невеликою проблемою:
[tree]
├ tree\dirA
│ ├ tree\dirA\dirB
│ │ └ tree\dirA\dirB\fileD
│ ├ tree\dirA\fileB
│ └ tree\dirA\fileC
└ tree\fileA
При використанні у поєднанні з a RecursiveDirectoryIteratorвін відображає всю назву шляху, а не лише ім'я файлу. Решта виглядає непогано. Це тому, що імена файлів генеруються SplFileInfo. Натомість вони повинні відображатися як базове ім'я. Бажаний результат є наступним:
[tree]
├ dirA
│ ├ dirB
│ │ └ fileD
│ ├ fileB
│ └ fileC
└ fileA
Створіть клас декоратора, який можна використовувати RecursiveTreeIteratorзамість RecursiveDirectoryIterator. Він повинен містити базове ім'я поточного SplFileInfoзамість імені шляху. Остаточний фрагмент коду тоді може виглядати так:
$lines = new RecursiveTreeIterator(
new DiyRecursiveDecorator($dir)
);
$unicodeTreePrefix($lines);
echo "[$path]\n", implode("\n", iterator_to_array($lines));
Ці фрагменти, зокрема, $unicodeTreePrefixє частиною суті в Додатку: Зроби сам: склади RecursiveTreeIteratorробочий рядок за рядком. .