WSVersion

Доступен с CMS 1.1.0

WSVersion предоставляет статические методы для работы с версиями. Класс доступен в PHP-коде темы без ручного подключения и создания объекта.

Поддерживает

  • проверку формата версии
  • дополнение двухкомпонентной версии до полного формата
  • сравнение версий с учётом предварительных выпусков
  • чтение сведений о версии из JSON

Быстрый старт

php
$version = WSVersion::normalize('1.1'); // '1.1.0'
$order = WSVersion::compare('1.1.2', '1.1.0'); // 1

Нормализация

normalize(string $version): ?string

Возвращает допустимую строку версии или null при неверном формате. Двухкомпонентная версия дополняется нулём: 1.1 превращается в 1.1.0.

Поддерживаются версии вида 1.1.2, 1.1.2-beta.1 и 1.1.2+build.5. Префикс v и пробелы не допускаются. Основные числа версии записываются без ведущих нулей.

Сравнение

compare(string $first, string $second): ?int

Возвращает -1, если первая версия меньше второй; 0, если версии равны; 1, если первая больше. Если хотя бы одна строка имеет неверный формат, возвращается null.

Числовые части сравниваются отдельно. Стабильный выпуск выше предварительного с теми же основными числами. Метаданные после + не влияют на результат.

php
WSVersion::compare('1.1.2-beta.1', '1.1.2'); // -1
WSVersion::compare('1.1.2+build.5', '1.1.2'); // 0

Сведения о версии

Метод Назначение
readInfo(string $path): ?array Читает JSON-файл по переданному пути и проверяет сведения о версии.
parseInfo(string $source): ?array Проверяет сведения о версии в переданной JSON-строке.

JSON должен содержать строковые поля version и name, например {"version":"1.1.2","name":"example"}. Версия должна иметь допустимый формат, а название не должно быть пустым или состоять только из пробелов.

Оба метода возвращают массив с ключами version и name. Исходные строки сохраняются: значение 1.1 не заменяется на 1.1.0. Дополнительные поля JSON в результат не включаются.

При неверном JSON, отсутствии обязательных полей или недопустимых значениях возвращается null. Метод readInfo() также возвращает null, если файл отсутствует или его невозможно прочитать.