Ds\Sequence::unshift — Добавляет значения в начало последовательности

Назначение Ds\Sequence::unshift

Ds\Sequence::unshift: Добавляет значения в начало последовательности. Справочная сущность относится к разделу «ds». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается Ds\Sequence::unshift

Эта страница описывает член unshift класса Ds\Sequence, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: abstract, public. Входной контракт: необязательные $values; объявленный результат — void.

Смысловое направление Ds\Sequence::unshift

Смысловое направление Ds\Sequence::unshift — «изменение состояния». В прикладном коде до вызова сохраните ожидаемое исходное состояние, после — проверьте фактическое изменение. Контрольный набор для этой операции: проверьте идемпотентность повтора и конфликт параллельного обновления. Такой акцент отделяет Ds\Sequence::unshift от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура Ds\Sequence::unshift

Структурная запись: abstract public void Ds\Sequence::unshift(mixed $values = значение по умолчанию). В ней 1 параметр: необязательные $values. Результат объявлен как void; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры Ds\Sequence::unshift

Порядок и роли аргументов по сигнатуре: 1. $values — mixed, необязателен. Для Ds\Sequence::unshift фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для Ds\Sequence::unshift

1) mixed $values — необязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений.

Результат Ds\Sequence::unshift

Ds\Sequence::unshift объявляет результат типа void. Ds\Sequence::unshift объявлена с результатом void. Проверяйте наблюдаемый эффект и диагностику вызова; присваивание результата не подтверждает успешность операции.

Проверочный сценарий для Ds\Sequence::unshift

Подготовьте объект Ds\Sequence в минимально допустимом состоянии. Сначала выполните контрольный вызов без аргументов. Затем отдельно добавьте необязательные параметры mixed $values, чтобы увидеть влияние значений по умолчанию. Для профиля «контракт PHP» важно зафиксировать предусловия вызова и не подавлять диагностические сообщения; негативный сценарий должен проверить штатный результат, граничный вход и документированный отказ.

Интеграция Ds\Sequence::unshift в проект

Храните подготовку Ds\Sequence и вызов Ds\Sequence::unshift в одном понятном жизненном цикле; не скрывайте обязательное состояние объекта в глобальной переменной. Для профиля «контракт PHP» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция Ds\Sequence::unshift не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика Ds\Sequence::unshift

Сначала запишите точную сигнатуру abstract public void Ds\Sequence::unshift(mixed $values = значение по умолчанию) и фактические типы переданных значений. Затем проверьте состояние экземпляра Ds\Sequence непосредственно перед методом Ds\Sequence::unshift. Если результат неожиданен, сравните его тип с void и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «контракт PHP» применяйте отдельный негативный тест: проверить штатный результат, граничный вход и документированный отказ. В production-коде важно зафиксировать предусловия вызова и не подавлять диагностические сообщения. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать Ds\Sequence::unshift

Выбор Ds\Sequence::unshift оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к Ds\Sequence; 2) сигнатура содержит 1 аргумент: обязательных 0, необязательных 1; 3) вызывающему коду нужен результат void и действие «изменение состояния». Для профиля «контракт PHP» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с Ds\Deque::unshift: у него другое назначение, владелец или набор входных данных.

Сравнение Ds\Sequence::unshift с соседними API

Для Ds\Sequence::unshift базовый ориентир: добавляет значения в начало последовательности; необязательные $values; результат void. Совпадение имени unshift не делает методы взаимозаменяемыми: Ds\Sequence::unshift принадлежит Ds\Sequence, а Ds\Deque::unshift — Ds\Deque. Сначала определите фактический тип объекта. Сопоставление с опубликованными соседями: Ds\Deque::unshift: добавляет значения в начало двухсторонней очереди; вход — необязательные $values; результат — void. Ds\Vector::unshift: добавляет значения в начало вектора; вход — необязательные $values; результат — void. Ds\Sequence::push: добавляет значения в конец последовательности; вход — обязательные $...values; вариативные $...values; результат — void. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

Ds\Sequence::unshift сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для Ds\Sequence::unshift.

Связанные материалы