cakedc/cakephp-phpstan

CakePHP 5 plugin extension for PHPStan.

Installs: 225 567

Dependents: 15

Suggesters: 0

Security: 0

Stars: 25

Watchers: 15

Forks: 5

Open Issues: 5

Type:phpstan-extension

3.1.1 2024-02-23 17:11 UTC

README

Build Status Downloads Latest Version License

Provide services and rules for a better PHPStan analyze on CakePHP applications, includes services to resolve types (Table, Helpers, Behaviors, etc) and multiple rules.

Installation

To use this extension, require it through Composer:

composer require --dev cakedc/cakephp-phpstan

If you also install phpstan/extension-installer, then you're all set!

Manual installation

If you don't want to use phpstan/extension-installer, include extension.neon in your project's PHPStan config:

includes:
    - vendor/cakedc/cakephp-phpstan/extension.neon

General class load|fetch extensions

Features included:

  1. Provide correct return type for Cake\ORM\Locator\LocatorInterface::get()
  2. Provide correct return type for Cake\Controller\Controller::loadComponent()
  3. Provide correct return type for Cake\Controller\Controller::fetchTable()
  4. Provide correct return type for Cake\Controller\Component::fetchTable()
  5. Provide correct return type for Cake\Command\Command::fetchTable()
  6. Provide correct return type for Cake\Mailer\Mailer::fetchTable()
  7. Provide correct return type for Cake\View\Cell::fetchTable()
  8. Provide correct return type for Cake\Console\ConsoleIo::helper()

Table class return type extensions

TableEntityDynamicReturnTypeExtension

  1. Provide correct return type for Cake\ORM\Table::get based on your table class name
  2. Provide correct return type for Cake\ORM\Table::newEntity based on your table class name
  3. Provide correct return type for Cake\ORM\Table::newEntities based on your table class name
  4. Provide correct return type for Cake\ORM\Table::newEmptyEntity based on your table class name
  5. Provide correct return type for Cake\ORM\Table::findOrCreate based on your table class name
Examples:
  //Now PHPStan know that \App\Models\Table\NotesTable::get returns \App\Model\Entity\Note
  $note = $this->Notes->get(1);
  $note->note = 'My new note';//No error

  //Now PHPStan know that \App\Models\Table\NotesTable::newEntity returns \App\Model\Entity\Note
  $note = $this->Notes->newEntity($data);
  $note->note = 'My new note new entity';//No error

  //Now PHPStan know that \App\Models\Table\NotesTable::newEmptyEntity returns \App\Model\Entity\Note
  $note = $this->Notes->newEmptyEntity($data);
  $note->note = 'My new note new empty entity';//No error

   //Now PHPStan know that \App\Models\Table\NotesTable::findOrCreate returns \App\Model\Entity\Note
  $note = $this->Notes->findOrCreate($data);
  $note->note = 'My entity found or created';//No error

  //Now PHPStan know that \App\Models\Table\NotesTable::newEntities returns \App\Model\Entity\Note[]
  $notes = $this->Notes->newEntities($data);
  foreach ($notes as $note) {
    $note->note = 'My new note';//No error
  }

TableFirstArgIsTheReturnTypeExtension

  1. Provide correct return type for Cake\ORM\Table::patchEntity based on the first argument passed
  2. Provide correct return type for Cake\ORM\Table::patchEntities based on the first argument passed
  3. Provide correct return type for Cake\ORM\Table::save based on the first argument passed
  4. Provide correct return type for Cake\ORM\Table::saveOrFail based on the first argument passed
  5. Provide correct return type for Cake\ORM\Table::saveMany based on the first argument passed
  6. Provide correct return type for Cake\ORM\Table::saveManyOrFail based on the first argument passed
  7. Provide correct return type for Cake\ORM\Table::deleteMany based on the first argument passed
  8. Provide correct return type for Cake\ORM\Table::deleteManyOrFail based on the first argument passed
Examples:
  //Now PHPStan know that \App\Models\Table\NotesTable::get returns \App\Model\Entity\Note
  $note = $this->Notes->get(1);
  $notes = $this->Notes->newEntities($data);

  //Since PHPStan knows the type of $note, these methods call use the same type as return type:
  $note = $this->Notes->patchEntity($note, $data);
  $text = $note->note;//No error.

  $note = $this->Notes->save($note);
  $text = $note->note;//No error.

  $note = $this->Notes->saveOrFail($note);
  $text = $note->note;//No error.
  //Since PHPStan knows the type of $notes, these methods call use the same type as return type:
  $notes = $this->Notes->patchEntities($notes);
  $notes = $this->Notes->saveMany($notes);
  $notes = $this->Notes->saveManyOrFail($notes);
  $notes = $this->Notes->deleteMany($notes);
  $notes = $this->Notes->deleteManyOrFail($notes);

Rules

All rules provided by this library are included in rules.neon and are enabled by default:

AddAssociationExistsTableClassRule

This rule check if the target association has a valid table class when calling to Table::belongsTo, Table::hasMany, Table::belongsToMany, Table::hasOne and AssociationCollection::load.

AddAssociationMatchOptionsTypesRule

This rule check if association options are valid option types based on what each class expects. This cover calls to Table::belongsTo, Table::hasMany, Table::belongsToMany, Table::hasOne and AssociationCollection::load.

AddBehaviorExistsClassRule

This rule check if the target behavior has a valid table class when calling to Table::addBehavior and BehaviorRegistry::load.

OrmSelectQueryFindMatchOptionsTypesRule

This rule check if the options (args) passed to Table::find and SelectQuery are valid find options types.

TableGetMatchOptionsTypesRule

This rule check if the options (args) passed to Table::get are valid find options types.

How to disable a rule

Each rule has a parameter in cakeDC 'namespace' to enable or disable, it is the same name of the rule with first letter in lowercase. For example to disable the rule AddAssociationExistsTableClassRule you should have

parameters:
	cakeDC:
	 	addAssociationExistsTableClassRule: false

PHPDoc Extensions

TableAssociationTypeNodeResolverExtension

Fix intersection association phpDoc to correct generic object type, ex:

Change \Cake\ORM\Association\BelongsTo&\App\Model\Table\UsersTable to \Cake\ORM\Association\BelongsTo<\App\Model\Table\UsersTable>

Tips

To make your life easier make sure to have @mixin and @method annotations in your table classes. The @mixin annotation will help phpstan know you are using methods from behavior, and @method annotations will allow it to know the correct return types for methods like Table::get(), Table::newEntity().

You can easily update annotations with the plugin IdeHelper.

Support

For bugs and feature requests, please use the issues section of this repository.

Commercial support is also available, contact us for more information.

Contributing

If you'd like to contribute new features, enhancements or bug fixes to the plugin, please read our Contribution Guidelines for detailed instructions.