phpstan codeigniter

Extensions et règles de codeigniter pour phpstan

• Phpstan
• Codeigniter

Cette extension fournit les fonctionnalités suivantes:

Type d'inférence

• Fournit des types de retour précis pour les fonctions config() et model() .
• Fournit des types de retour précis pour les fonctions service() et single_service() .
• Fournit des types de retour précis pour fake() .
• Fournit des types de retour précis pour les méthodes find() , findAll() et first() CodeIgniterModel .
• Permet la transformation dynamique du type de retour de CodeIgniterModel lorsque asArray() ou asObject() est appelée.

Règles

• Vérifie si l'argument de chaîne transmis à config() ou model() est une chaîne de classe valide étendant respectivement CodeIgniterConfigBaseConfig ou CodeIgniterModel . Cela peut être désactivé en définissant codeigniter.checkArgumentTypeOfFactories: false dans votre phpstan.neon . Pour un contrôle à grain fin, vous pouvez choisir individuellement la fonction d'usine à désactiver en utilisant codeigniter.checkArgumentTypeOfConfig et codeigniter.checkArgumentTypeOfModel . Remarque: Définition codeigniter.checkArgumentTypeOfFactories: false contournera efficacement les deux options spécifiques.
• Vérifie si l'argument de chaîne transmis à service() ou single_service() est un nom de service valide. Cela peut être désactivé en définissant codeigniter.checkArgumentTypeOfServices: false dans votre phpstan.neon .
• Interdit les gestionnaires de cache instanciants utilisant new et suggère d'utiliser la classe CacheFactory à la place.
• Interdit les classes FrameworkException instanciantes en utilisant new .
• Interdit la réaffectation directe ou l'accès de $_SERVER et $_GET et suggère d'utiliser la classe Superglobals à la place.
• Interdit l'utilisation de ::class sur config() et model() et suggère d'utiliser la forme courte de la classe à la place.

Installation

Pour utiliser cette extension, nécessitez-le dans le compositeur:

 composer require --dev codeigniter/phpstan-codeigniter

Si vous installez également PhpStan / Extension-Installer, vous êtes tous réglés!

Installation manuelle

Si vous ne souhaitez pas utiliser phpstan/extension-installer , incluez l'extension.neon dans la configuration phpstan de votre projet:

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

Le développement dans ce référentiel utilise PHP 8.1+ .

Démarrage de V1.1.0, les versions sont livrées avec une version rétrogradée pour s'adapter aux versions PHP inférieures. Actuellement, la version PHP rétrograrée la plus faible est PHP 7.4 .

Configuration

Cette extension ajoute l'espace de noms par défaut pour config() et model() les fonctions comme Config et AppModels , respectivement, lors de la recherche de classes possibles. Si votre application utilise d'autres espaces de noms, vous pouvez configurer cette extension dans votre phpstan.neon pour reconnaître ces espaces de noms:

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

Pour les fonctions service() et single_service() , vous pouvez demander à PHPSTAN de considérer vos propres classes d'usine de services. Veuillez noter que ce devrait être une classe valide étendant CodeIgniterConfigBaseService !

 parameters :
  codeigniter :
    additionalServices :
      - AcmeBlogConfigServiceFactory

Lorsque le modèle transmis à fake() a la propriété $returnType définie sur array , cette extension donnera une forme de tableau précise basée sur les champs autorisés du modèle. La plupart du temps, les champs formatés sont des cordes. Si ce n'est pas une chaîne, vous pouvez indiquer le type de retour au format pour le champ particulier.

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

Mises en garde

1. Le comportement des usines fonctionne par rapport à la façon dont ils chargent les classes est basé sur CodeIgniter4 / Framework v4.4. Si vous comptez sur le comportement de <v4.4, cela peut ne pas fonctionner pour vous.

Contributif

Toutes les contributions sont les bienvenues.

Si vous souhaitez voir une nouvelle règle ou une nouvelle extension spécifique à CodeIgniter, veuillez ouvrir une demande de fonctionnalité. Si vous pouvez contribuer le code vous-même, veuillez ouvrir une demande de traction à la place.

Avant de signaler des bogues, veuillez vérifier si le bogue ne se produit que si vous utilisez cette extension avec PHPSTAN. Si le bogue est reproductible dans PHPSTAN seul, veuillez y ouvrir un rapport de bogue. Merci!

Licence

PHPSTAN Codeigniter est une bibliothèque open source sous licence MIT.