lordsimal/cakephp-psalm

A psalm-plugin for CakePHP

2.0.0 2023-09-10 08:08 UTC

Requires

• ext-simplexml: *
• cakephp/cakephp: ^5.0.0
• vimeo/psalm: ^5.0

Requires (Dev)

• codeception/codeception: ^5
• phpunit/phpunit: ^10.1
• psalm/plugin-phpunit: ^0.16.0
• squizlabs/php_codesniffer: ^3.3
• weirdan/codeception-psalm-module: ^0.14
• weirdan/prophecy-shim: ^2.0

MIT

• Kevin Pfeifer

README

Overview

This plugin provides correct return types for CakePHP specific methods in psalm.

Quickstart

Please refer to the full Psalm documentation for a more detailed guide on how to use Psalm in your project.

First you need to install the psalm base package and create a psalm.xml

composer require --dev vimeo/psalm
./vendor/bin/psalm --init

Next you will need to require this package and enable it in psalm

composer require --dev lordsimal/cakephp-psalm
./vendor/bin/psalm-plugin enable lordsimal/cakephp-psalm

Finally you can try it out

./vendor/bin/psalm

How it works

Currently only the following return types are being corrected:

• Cake\ORM\Locator\LocatorInterface::get()
• Cake\ORM\Locator\LocatorAwareTrait::fetchTable()

The functionality for this can be found in src/Type/TableLocatorHandler.php

In there the getClassLikeNames() tells psalm on which classes it needs to change return types.

In the getMethodReturnType() we check which method is currently called and get the first argument value from that call.

With that value we get the "real" FQCN of the table which is returned in runtime and tell psalm to use that instead of the default Cake\ORM\Table.

Help needed

I would definitely appreciate help related to the following aspects of this plugin:

• Testing
• Including more return types like CakeDC/cakephp-phpstan already does for PHPStan