reset

(PHP 4, PHP 5, PHP 7, PHP 8)

reset — Встановлює внутрішній вказівних масиву на його перший елемент

Опис

reset(array|object &$array): mixed

reset() переміщує внутрішній вказівник масиву array до його першого елемента та повертає значення цього елемента.

Параметри

array: Вхідний масив.

Значення, що повертаються

Повертає значення першого елемента масиву або false, якщо масив порожній.

Увага

Ця функція може повертати як логічне false, так і не логічне значення, яке прирівнюється до false. Докладніше про це описано в розділі Логічні типи даних. Для перевірки значення, яке повертає ця функція, використовується оператор ===.

Журнал змін

Версія	Опис
8.1.0	Виклик цієї функції для об'єктів є застарілим. Краще перетворити object в array, застосувавши get_mangled_object_vars(), або використати методи класу, який імплементує Iterator, наприклад ArrayIterator.
7.4.0	Примірники класів SPL тепер розглядаються як порожні об'єкти, які не мають властивостей, замість виклику метода інтерфейсу Iterator з такою ж назвою, як і в цієї функції.

Приклади

Приклад #1 Використання reset()

<?php

$array = array('крок перший', 'крок другий', 'крок третій', 'крок четвертий');

// Початково вказівник знаходиться на першому елементі
echo current($array) . "<br />\n"; // "крок перший"

// Пропустимо два кроки
next($array);
next($array);
echo current($array) . "<br />\n"; // "крок третій"

// Перевстановлення вказівника, починається знову з "крок перший"
reset($array);
echo current($array) . "<br />\n"; // "крок перший"

?>

Примітки

Зауваження: Значення, що повертається для порожнього масиву, таке ж, як для масиву, у якого перший елемент — bool false. Щоб точно визначити, що значення першого елемента масиву може бути false, треба поміряти() масив або перевірити, чи не повертає функція key() null після виклику reset().

Прогляньте також

current() - Return the current element in an array
each() - Return the current key and value pair from an array and advance the array cursor
end() - Set the internal pointer of an array to its last element
next() - Advance the internal pointer of an array
prev() - Rewind the internal array pointer
array_key_first() - Gets the first key of an array