phpstan codeigniter

Расширения и правила Codeigniter для Phpstan

• Phpstan
• Codeigniter

Это расширение предоставляет следующие функции:

Тип вывод

• Предоставляет точные типы возврата для функций config() и model() .
• Предоставляет точные типы возврата для функций service() и single_service() .
• Предоставляет точные типы возврата для функции вспомогательной fake() .
• Предоставляет точные типы возврата для методов CodeIgniterModel find() , findAll() и first() .
• Позволяет динамическое преобразование типа возврата CodeIgniterModel , когда вызывается asArray() или asObject() .

Правила

• Проверяет, передается ли аргумент строки в функцию config() или model() является действительной строкой класса расширяющимся CodeIgniterConfigBaseConfig или CodeIgniterModel , соответственно. Это можно отключить, установив codeigniter.checkArgumentTypeOfFactories: false в вашем phpstan.neon . Для мелкозернистого управления вы можете индивидуально выбрать, какую заводскую функцию отключите с помощью codeigniter.checkArgumentTypeOfConfig и codeigniter.checkArgumentTypeOfModel . Примечание. Настройка codeigniter.checkArgumentTypeOfFactories: false эффективно обходится двумя конкретными параметрами.
• Проверяет, передается ли аргумент строки в функцию service() или single_service() является действительным именем службы. Это можно отключить, установив codeigniter.checkArgumentTypeOfServices: false в вашем phpstan.neon .
• Devallows создание обработчиков кэша с использованием new и предлагает вместо этого использовать класс CacheFactory .
• Devallows Intallowing FrameworkException Classcessception с использованием new .
• DESALLOWS DIRECTERSENTINGERMENT или доступ $_SERVER и $_GET и предлагает вместо этого использовать класс Superglobals .
• DESALLOWS ИСПОЛЬЗОВАНИЕ ::class Fetch на config() и model() и предлагает вместо этого использовать короткую форму класса.

Установка

Чтобы использовать это расширение, требовать его в композиторе:

 composer require --dev codeigniter/phpstan-codeigniter

Если вы также установите Phpstan/Extension-Installer, то вы все настроены!

Ручная установка

Если вы не хотите использовать phpstan/extension-installer , включите Extension.neon в конфигурации вашего проекта Phpstan:

 includes :
    - vendor/codeigniter/phpstan-codeigniter/extension.neon

Развитие в этом репозитории использует PHP 8.1+ .

Начиная с v1.1.0, выпуски поставляются с пониженной версией в соответствии с более низкими версиями PHP. В настоящее время самая низкая поддержанная понижаемая версия PHP - PHP 7.4 .

Конфигурация

Это расширение добавляет пространство имен по умолчанию для config() и model() функционирует как Config и AppModels , соответственно, при поиске возможных классов. Если ваше приложение использует другие пространства имен, вы можете настроить это расширение в своем phpstan.neon для распознавания этих пространств имен:

 parameters :
  codeigniter :
    additionalConfigNamespaces :
      - AcmeBlogConfig
      - FooBarConfig
    additionalModelNamespaces :
      - AcmeBlogModels

Для функций service() и single_service() вы можете указать PHPSTAN рассмотреть свои собственные классы фабрики услуг. Обратите внимание, что это должен быть действительный класс, расширяющий CodeIgniterConfigBaseService !

 parameters :
  codeigniter :
    additionalServices :
      - AcmeBlogConfigServiceFactory

Когда модель, передаваемая в fake() имеет свойство $returnType установленное на array , это расширение даст точную форму массива на основе разрешенных полей модели. В большинстве случаев форматированные поля являются строками. Если не строка, вы можете указать тип возврата формата для конкретного поля.

 parameters :
  codeigniter :
    notStringFormattedFields : # key-value pair of field => format
      success : bool
      user_id : int 

Предостережения

1. Поведение заводов функционирует по сравнению с тем, как они загружают классы, основано на Codeigniter4/Framework v4.4. Если вы полагаетесь на поведение <v4.4, это может не сработать для вас.

Внося

Любые взносы приветствуются.

Если вы хотите увидеть новое правило или расширение, специфичное для Codeigniter, откройте запрос на функцию. Если вы можете внести свой вклад сам, пожалуйста, откройте запрос на вытяжку.

Прежде чем сообщать о каких -либо ошибках, проверьте, возникает ли ошибка, только если использует это расширение с Phpstan. Если ошибка воспроизводима только в Phpstan, вместо этого откройте там отчет об ошибке. Спасибо!

Лицензия

Phpstan Codeigniter - это библиотека с открытым исходным кодом, лицензированная в соответствии с MIT.