memory_get_peak_usage — Возвращает пиковое значение памяти, которую потребил PHP-скрипт или которую система выделила PHP-процессу

Назначение memory_get_peak_usage

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

Чем отличается memory_get_peak_usage

Это процедурная функция раздела «Информация о PHP». Её отличают имя memory_get_peak_usage, контракт «необязательные $real_usage» и объявленный результат int; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление memory_get_peak_usage

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

Сигнатура memory_get_peak_usage

Структурная запись: int memory_get_peak_usage(bool $real_usage = false). В ней 1 параметр: необязательные $real_usage. Результат объявлен как int; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры memory_get_peak_usage

Порядок и роли аргументов по сигнатуре: 1. $real_usage — bool, необязателен, default false. Для memory_get_peak_usage фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для memory_get_peak_usage

1) bool $real_usage — необязательный: передайте true и false явно, не полагаясь на нестрогое приведение скалярных значений.

Результат memory_get_peak_usage

memory_get_peak_usage объявляет результат типа int. Числовой результат memory_get_peak_usage имеет тип int. Не назначайте специальный смысл нулю или отрицательному значению, пока он не следует из документированного контракта.

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

Убедитесь, что раздел «Информация о PHP» доступен в целевой сборке PHP. Сначала выполните контрольный вызов без аргументов. Затем отдельно добавьте необязательные параметры bool $real_usage=false, чтобы увидеть влияние значений по умолчанию. Для профиля «процессы и конкурентность» важно фиксировать жизненный цикл ресурса и границы повторного запуска; негативный сценарий должен проверить конкуренцию, отмену, повтор и освобождение ресурса.

Интеграция memory_get_peak_usage в проект

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

Диагностика memory_get_peak_usage

Сначала запишите точную сигнатуру int memory_get_peak_usage(bool $real_usage = false) и фактические типы переданных значений. Затем подтвердите загрузку расширения «Информация о PHP» в той же среде, где выполняется memory_get_peak_usage. Если результат неожиданен, сравните его тип с int и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

Когда выбирать memory_get_peak_usage

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

Сравнение memory_get_peak_usage с соседними API

Для memory_get_peak_usage базовый ориентир: возвращает пиковое значение памяти, которую потребил php-скрипт или которую система выделила php-процессу; необязательные $real_usage; результат int. Сопоставление с опубликованными соседями: memory_get_usage: возвращает количество памяти, которую потребляет php-скрипт или которую система выделила php-процессу; вход — необязательные $real_usage; результат — int. memory_reset_peak_usage: сбрасывает пиковое значение объёма памяти, выделенной php; вход — аргументов нет; результат — void. gc_mem_caches: освобождает память, которую использует менеджер памяти zend engine; вход — аргументов нет; результат — int. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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