ZipArchive::setEncryptionIndex — Устанавливает метод шифрования записи по индексу

Назначение ZipArchive::setEncryptionIndex

ZipArchive::setEncryptionIndex: Устанавливает метод шифрования записи по индексу. Справочная сущность относится к разделу «ZIP». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается ZipArchive::setEncryptionIndex

Эта страница описывает член setEncryptionIndex класса ZipArchive, а не одноимённую процедурную функцию. В исходной сигнатуре зафиксированы модификаторы: public. Входной контракт: обязательные $index, $method; необязательные $password; объявленный результат — bool.

Смысловое направление ZipArchive::setEncryptionIndex

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

Сигнатура ZipArchive::setEncryptionIndex

Структурная запись: public bool ZipArchive::setEncryptionIndex(int $index, int $method, #[\SensitiveParameter] string|null $password = null). В ней 3 параметра: обязательные $index, $method; необязательные $password. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ZipArchive::setEncryptionIndex

Порядок и роли аргументов по сигнатуре: 1. $index — int, обязателен; 2. $method — int, обязателен; 3. $password — #[\SensitiveParameter] string|null, необязателен, default null.

Контроль входных данных для ZipArchive::setEncryptionIndex

1) int $index — обязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 2) int $method — обязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 3) #[\SensitiveParameter] string|null $password — необязательный: не журналируйте исходное значение и проверьте отказ на неверных учётных данных.

Результат ZipArchive::setEncryptionIndex

ZipArchive::setEncryptionIndex объявляет результат типа bool. ZipArchive::setEncryptionIndex возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

Проверочный сценарий для ZipArchive::setEncryptionIndex

Подготовьте объект ZipArchive в минимально допустимом состоянии. Сначала выполните контрольный вызов с обязательным набором int $index, int $method. Затем отдельно добавьте необязательные параметры #[\SensitiveParameter] string|null $password=null, чтобы увидеть влияние значений по умолчанию. Для профиля «безопасность» важно не записывать секреты и исходные ключи в журнал; негативный сценарий должен проверить неверный ключ, повреждённые данные и отказ операции.

Интеграция ZipArchive::setEncryptionIndex в проект

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

Диагностика ZipArchive::setEncryptionIndex

Сначала запишите точную сигнатуру public bool ZipArchive::setEncryptionIndex(int $index, int $method, #[\SensitiveParameter] string|null $password = null) и фактические типы переданных значений. Затем проверьте состояние экземпляра ZipArchive непосредственно перед методом ZipArchive::setEncryptionIndex. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать ZipArchive::setEncryptionIndex

Выбор ZipArchive::setEncryptionIndex оправдан, когда одновременно выполнены три условия: 1) объект действительно относится к ZipArchive; 2) сигнатура содержит 3 аргумента: обязательных 2, необязательных 1; 3) вызывающему коду нужен результат bool и действие «шифрование». Для профиля «безопасность» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с ZipArchive::setPassword: у него другое назначение, владелец или набор входных данных.

Сравнение ZipArchive::setEncryptionIndex с соседними API

Для ZipArchive::setEncryptionIndex базовый ориентир: устанавливает метод шифрования записи по индексу; обязательные $index, $method; необязательные $password; результат bool. Сопоставление с опубликованными соседями: ZipArchive::setPassword: устанавливает пароля для активного архива; вход — обязательные $password; результат — bool. ZipArchive::setEncryptionName: устанавливает метод шифрования записи по имени; вход — обязательные $name, $method; необязательные $password; результат — bool. ZipArchive::setCompressionIndex: устанавливает метод сжатия записи по индексу; вход — обязательные $index, $method; необязательные $compflags; результат — bool. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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