Перейти к содержимому
M
Все статьи
Разработка 8 мин чтения

Moodle и PHP 8: deprecated-предупреждения, типизация и что чинить в плагинах

Какие изменения PHP 8.0–8.4 ломают старые плагины Moodle, как находить deprecated-предупреждения и чем их заменять: таблица и примеры кода.

Какие изменения PHP 8.0–8.4 ломают старые плагины Moodle, как находить deprecated-предупреждения и чем их заменять: таблица и примеры кода.

После перехода на PHP 8 старый Moodle или старый плагин чаще всего не падает, а засыпает журнал предупреждениями. Но среди них прячутся и настоящие ошибки, которые на PHP 7.4 молчали, а на 8.x останавливают страницу. Я перевела на PHP 8 несколько СДО и десяток плагинов, и набор проблем повторяется. Разберу, как их находить и что с ними делать.

Какая версия PHP нужна вашей версии Moodle

Прежде чем чинить плагины, убедитесь, что сам Moodle поддерживает целевой PHP. Старые ветки на новом PHP не запустятся или будут работать нестабильно, а новые не запустятся на старом. Соответствие меняется от релиза к релизу, и точные границы смотрите на странице релизов Moodle. Общее правило: поднимайте версию PHP одновременно с обновлением Moodle до ветки, которая её официально поддерживает, а не «заодно» на старом ядре. Это относится к плану обновления Moodle: PHP, ядро и плагины двигаются согласованно.

Как находить проблемы

Включите режим разработчика, откройте страницы плагина и просмотрите вывод. Предупреждения типа Deprecated показывают, что код ещё работает, но в будущем перестанет. Ошибки типа TypeError и Fatal — это уже остановка. Для массовой проверки кода без запуска полезны линтер PHP на целевой версии (php -l на каждом файле) и phpcs с набором правил совместимости. Подробно, как включать отладку и где читать журналы, — в статье про отладку Moodle.

Таблица типичных проблем

Версия PHPЧто изменилосьКак проявляется в плагинеЧто делать
8.0передача неверного типа во встроенные функции — исключение TypeError; count(null) и подобное — ошибкастраница падает там, где раньше был пустой результатпроверять значения перед вызовом, использовать явные приведения
8.0другое правило сравнения строки с числомусловие 0 == 'abc' теперь ложно; меняется логикаиспользовать строгое сравнение ===
8.0функции create_function, each и другие устаревшие удаленыфатальная ошибкапереписать на анонимные функции и циклы
8.0обязательный параметр после необязательногоDeprecated на объявлении функциипереупорядочить параметры или убрать значение по умолчанию
8.1передача null в параметры встроенных функций, которые не принимают nullDeprecated на strlen(null), trim(null), htmlspecialchars(null)подставлять пустую строку или проверять значение
8.1типы возвращаемых значений у методов стандартных интерфейсовDeprecated в классах, реализующих Iterator, Countable, ArrayAccess, JsonSerializableдобавить тип возврата или атрибут #[\ReturnTypeWillChange]
8.1функция strftime устарелаDeprecated при форматировании датыиспользовать API времени Moodle (userdate) или DateTime
8.1неявное приведение дробного числа к целому с потерейDeprecated в индексах массивов и операцияхявное приведение или округление
8.2динамические свойства объекта устарелиDeprecated «Creation of dynamic property»объявить свойство в классе (для данных из базы — использовать stdClass)
8.2интерполяция ${var} в строках устарелаDeprecated в старом кодезаменить на {$var} или конкатенацию
8.2функции utf8_encode / utf8_decode устарелиDeprecated при работе с кодировкамииспользовать mb_convert_encoding или класс строк Moodle
8.4неявно допускающий null тип параметра (Type $x = null) устарелDeprecated на объявлении функциизаписать ?Type $x = null

Примеры исправлений

// Было: падение или Deprecated на PHP 8.1+ при null
$name = trim($record->middlename);

// Стало
$name = trim((string)($record->middlename ?? ''));

// Было: динамическое свойство (PHP 8.2)
class report {
    public function __construct() {
        $this->rows = [];
    }
}

// Стало
class report {
    /** @var array Строки отчёта. */
    private array $rows = [];
}

Объекты записей Moodle и динамические свойства

Предупреждение о динамических свойствах не касается объектов, которые Moodle возвращает из базы данных. Это экземпляры stdClass, и добавлять к ним поля можно. Проблема возникает в собственных классах, где свойства появляются «по месту». Если нужен класс с произвольным набором свойств, объявляйте его осознанно (например, наследуйтесь от stdClass) вместо того, чтобы подавлять предупреждение.

Как не подавлять предупреждения

Соблазн скрыть предупреждения оператором @ или понизить уровень отчёта об ошибках велик, особенно когда СДО нужна в понедельник. Подавление лишь откладывает проблему до обновления на следующую версию PHP, где вчерашнее предупреждение становится ошибкой. Допустимый компромисс — на продакшене не показывать предупреждения пользователям, но писать их в журнал и разбирать по приоритету: сначала то, что в часто вызываемом коде, затем остальное.

План работ для старого плагина

  1. Развернуть копию на целевой версии PHP, включить режим разработчика.
  2. Пройти пользовательские сценарии плагина и собрать журнал предупреждений.
  3. Сгруппировать предупреждения по типам из таблицы, исправить по группам.
  4. Прогнать линтер и проверку стиля (Code Checker).
  5. Добавить тесты на исправленные места (PHPUnit).
  6. Проверить совместимость с версией Moodle (совместимость плагина с версиями).

Типизация: стоит ли добавлять типы в старый код

Вместе с PHP 8 приходит соблазн расставить в плагине типы параметров и возвращаемых значений. Польза реальная: ошибки типов ловятся сразу, а редактор подсказывает вызовы. Но делать это стоит постепенно и с тестами. Если добавить строгий тип параметру, который в какой-то ветке получает строку из базы там, где вы ожидали число, страница упадёт с TypeError. Поэтому порядок такой: сначала типы у новых классов и методов, затем у тех мест, которые покрыты тестами, и только потом у остального кода. Директиву строгих типов на уровне файла (declare(strict_types=1)) в Moodle обычно не используют, так как данные из базы и форм приходят строками, и она ломает привычные вызовы. Если сомневаетесь, следуйте стилю ядра: он описан в правилах кодирования.

Современные возможности языка (именованные аргументы, match, свойства только для чтения, перечисления) используйте только если плагин заявляет поддержку PHP не ниже версии, где они появились. Иначе на старом сервере заказчика плагин не загрузится вообще. Минимальную версию PHP фиксируйте в документации плагина и проверяйте линтером на самой старой поддерживаемой версии.

Где искать причины, если ошибка не из таблицы

Не каждый сбой после смены PHP связан с изменением языка. Заметную долю составляют отсутствующие расширения (например, не установлены mbstring, intl, sodium или драйвер нужной базы данных), разные файлы php.ini у консоли и веба и сброшенные лимиты памяти. Проверьте вывод php -m от имени веб-пользователя, сравните значения memory_limit и max_input_vars со старой конфигурацией и убедитесь, что кэш OPcache сброшен после замены файлов. Только после этого ищите причину в коде плагина.

Чем PHP 8 помогает

Переход на новую версию — не только труд, но и польза. Строгая обработка типов выявляет ошибки, которые раньше тихо портили данные: сравнение строк с числами, обращение к несуществующему индексу массива, передача пустого значения туда, где ожидалось число. Многие из предупреждений, которые приходится исправлять, на самом деле были скрытыми дефектами, просто на старой версии они проявлялись раз в месяц на редких данных. Исправление этих мест повышает надёжность плагина и без учёта версии PHP, поэтому я рассматриваю такую работу как возможность навести порядок, а не как навязанную задачу.

Как проверить плагин на новой версии PHP до обновления сервера

Менять версию PHP на рабочем сервере ради проверки плагина не нужно. Достаточно запустить копию в контейнере с нужной версией (как поднять локальную среду) или установить рядом вторую версию PHP на тестовом сервере. Сначала я запускаю линтер на всех файлах плагина:

find local/myplugin -name '*.php' -print0 | xargs -0 -n1 php -l

Линтер находит только синтаксические ошибки и удалённые конструкции, поэтому за ним идут реальные запуски: установка плагина с нуля, обновление с предыдущей версии, основные страницы и запланированные задачи. Именно задачи по расписанию и обработчики событий чаще всего остаются непроверенными: они выполняются без участия человека, и предупреждения оседают в журнале cron, который никто не читает. Принудительно запустите их из консоли, как описано в статье про CLI-скрипты Moodle, и прочитайте вывод.

Бывает, что исходники плагина утеряны, а работает он только в виде развёрнутых файлов. Тогда правки вносятся прямо в них, но сначала снимите копию и заведите репозиторий git: без истории изменений любой следующий шаг будет вслепую. Если старая СДО требует перевода на PHP 8, а разбираться с каждым плагином некогда, это обычная задача для доработки Moodle или для технической поддержки.

Нужна помощь с Moodle?

Опишите задачу — расскажу, как решить её конкретно в вашем случае. Свяжитесь — разберём вместе.