phpstan codeigniter

Codesigniter -Erweiterungen und -regeln für Phpstan

• Phpstan
• Codesigniter

Diese Erweiterung enthält die folgenden Funktionen:

Geben Sie Inferenz ein

• Bietet präzise Rückgabetypen für config() und model() Funktionen.
• Bietet präzise Rückgabetypen für service() und single_service() -Funktionen.
• Bietet präzise Rückgabetypen für fake() Helper -Funktion.
• Bietet präzisen Rückgabetypen für die Methoden von CodeIgniterModel find() , findAll() und first() .
• Ermöglicht eine dynamische Rückgabe -Transformation des CodeIgniterModel , wenn asArray() oder asObject() aufgerufen wird.

Regeln

• Überprüft, ob das an config() oder model() übergebene String -Argument eine gültige Klassenzeichenfolge ist CodeIgniterConfigBaseConfig bzw. CodeIgniterModel erweitert. Dies kann ausgeschaltet werden, indem codeigniter.checkArgumentTypeOfFactories: false in Ihrem phpstan.neon . Für codeigniter.checkArgumentTypeOfModel feinkörnige Kontrolle können Sie individuell auswählen, welche Werksfunktion mit codeigniter.checkArgumentTypeOfConfig deaktiviert werden soll. HINWEIS: codeigniter.checkArgumentTypeOfFactories: false umgeht effektiv die beiden spezifischen Optionen.
• Überprüft, ob das String -Argument an service() oder single_service() übergeben wird, ist ein gültiger Dienstname. Dies kann ausgeschaltet werden, indem codeigniter.checkArgumentTypeOfServices: false in Ihrem phpstan.neon .
• Aktiviert die Instanziierung von Cache -Handlern mit new und schlägt vor, stattdessen die CacheFactory -Klasse zu verwenden.
• Aktiviert die Instanziierung FrameworkException -Klassen mit new .
• Die direkte Neuzuweisung oder den Zugriff von $_SERVER und $_GET addiert die direkte Neuzuordnung und schlägt vor, stattdessen die Superglobals -Klasse zu verwenden.
• Die Verwendung von ::class -Fetch auf config() und model() nicht ausgeht und schlägt vor, stattdessen die Kurzform der Klasse zu verwenden.

Installation

Um diese Erweiterung zu verwenden, benötigen Sie sie in Komponist:

 composer require --dev codeigniter/phpstan-codeigniter

Wenn Sie auch Phpstan/Extension-Installer installieren, sind Sie alle festgelegt!

Manuelle Installation

Wenn Sie phpstan/extension-installer nicht verwenden möchten, enthalten Sie die Erweiterung.neon in der Phpstan-Konfiguration Ihres Projekts:

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

Die Entwicklung in diesem Repository verwendet PHP 8.1+ .

Starten von V1.1.0 werden die Veröffentlichungen mit einer heruntergestuften Version ausgestattet, die niedrigere PHP -Versionen entspricht. Derzeit ist die am niedrigsten unterstützte heruntergestufte PHP -Version PHP 7.4 .

Konfiguration

Diese Erweiterung fügt den Standard -Namespace für config() und model() als Config bzw. AppModels hinzu, wenn nach möglichen Klassen gesucht wird. Wenn Ihre Anwendung andere Namespaces verwendet, können Sie diese Erweiterung in Ihrem phpstan.neon konfigurieren, um diese Namespaces zu erkennen:

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

Für den service() und die Funktionen () und single_service() können Sie Phpstan anweisen, Ihre eigenen Dienste -Fabrikkurse zu berücksichtigen. Bitte beachten Sie, dass es sich um eine gültige Klassenerweiterung CodeIgniterConfigBaseService handelt!

 parameters :
  codeigniter :
    additionalServices :
      - AcmeBlogConfigServiceFactory

Wenn das Modell an fake() übergeben wird, hat die Eigenschaft $returnType auf array eingestellt, diese Erweiterung ergibt eine präzise Array -Form, die auf den zulässigen Feldern des Modells basiert. Meistens sind die formatierten Felder Saiten. Wenn nicht eine Zeichenfolge, können Sie den Formatrückgabe -Typ für das bestimmte Feld angeben.

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

Einschränkungen

1. Das Verhalten von Fabriken funktioniert im Verhältnis zum Laden von Klassen auf Codesigniter4/Framework v4.4. Wenn Sie sich auf das Verhalten von <v4.4 verlassen, funktioniert dies möglicherweise nicht für Sie.

Beitragen

Alle Beiträge sind willkommen.

Wenn Sie eine neue Regel oder Erweiterung sehen möchten, die für CodeIgniter spezifisch ist, öffnen Sie bitte eine Funktionsanforderung. Wenn Sie den Code selbst beitragen können, öffnen Sie stattdessen eine Pull -Anfrage.

Bitte prüfen Sie, ob der Fehler nur dann auftritt, wenn diese Erweiterung mit Phpstan verwendet wird. Wenn der Fehler allein in Phpstan reproduzierbar ist, öffnen Sie dort stattdessen einen Fehlerbericht. Danke schön!

Lizenz

Phpstan Codesigniter ist eine unter MIT lizenzierte Open -Source -Bibliothek.