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) объявлен устаревшим. Объект (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, сначала функцией count() проверяют количество элементов в массиве или после вызова функции reset() проверяют, что ключ, возвращаемый функцией key(), не равен значению null.

Смотрите также

  • current() - Возвращает текущий элемент массива
  • each() - Возвращает текущую пару ключа и значения массива и сдвигает указатель на одну позицию вперёд
  • end() - Устанавливает внутренний указатель массива на последний элемент
  • next() - Сдвигает внутренний указатель массива на одну позицию вперёд
  • prev() - Сдвигает внутренний указатель массива на одну позицию назад
  • array_key_first() - Получает первый ключ массива
To Top