phpstan-drupal

RenderCallbackRule Improvements

The RenderCallbackRule added in 1.1.5 had various flaws. This release should fix them:

• Improper analysis of #access_callback – not an array, single callable.
• Improper analysis of #lazy_builder – an array, but of call_user_func_array values ([callable, args])
• service_name:method style callbacks were not parsed, now they are

What's Changed

• Calling getStorage with a constant does not resolve entity mapped storage class by @dpi in https://github.com/mglaman/phpstan-drupal/pull/300
• Handle controller notation for callbacks by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/302
• Fix #lazy_builder callback analysis and static::class concatenation warning by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/304

New Contributors

• @dpi made their first contribution in https://github.com/mglaman/phpstan-drupal/pull/300

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.7...1.1.8

What's Changed

• Remove nette/finder for symfony/finder (reusing Drupal dependencies) by @alexpott in https://github.com/mglaman/phpstan-drupal/pull/297

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.6...1.1.7

Hotfix.

What's Changed

• Fix/render callback by @alexpott in https://github.com/mglaman/phpstan-drupal/pull/292

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.5...1.1.6

What's Changed

• Require PHP ^7.4 by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/290
• #pre_render callback rule by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/217

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.4...1.1.5

What's Changed

• Add phpstan prophecy suggestion by @ptt-homme in https://github.com/mglaman/phpstan-drupal/pull/282
• Add phpstan/phpstan-phpunit to the suggested packages list by @ptt-homme in https://github.com/mglaman/phpstan-drupal/pull/283
• Add documentation for contrib entity mapping by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/285
• Add tips to the extends internal class rule errors by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/286
• Add return type extensions for AccessResult methods by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/287

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.3...1.1.4

What's Changed

• Expand list of entity type storages by @ptt-homme in https://github.com/mglaman/phpstan-drupal/pull/277
• Allow ::referencedEntities on field items by @eiriksm in https://github.com/mglaman/phpstan-drupal/pull/265

New Contributors

• @ptt-homme made their first contribution in https://github.com/mglaman/phpstan-drupal/pull/277

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.2...1.1.3

Highlights

With #264 we have added the ability to look up discovered extensions, which should greatly improve the rules which load files called by module_load_include and ModuleHandlerInterface::loadInclude. Previously these two rules had to re-scan for extensions whenever the function or method was analyzed.

What's Changed

• Fail to map a service with a parent which overrides its parent too by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/260
• Detect when a class extends a class that has been flagged as @internal by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/248
• issue #142: resolve incorrect $reflection definition by @eugene-brit in https://github.com/mglaman/phpstan-drupal/pull/178
• Add 10.0.x to tests by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/269
• Make the discovered Drupal extensions accessible via a service by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/264
• Respect @property annotations on Entity classes by @jacktonkin in https://github.com/mglaman/phpstan-drupal/pull/268

New Contributors

• @eugene-brit made their first contribution in https://github.com/mglaman/phpstan-drupal/pull/178
• @jacktonkin made their first contribution in https://github.com/mglaman/phpstan-drupal/pull/268

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.1...1.1.2

Major fix for sites without drupal/core-dev

This release includes fixes for Class PHPUnit\Framework\TestCase not found. errors!

Note you must have this in your phpstan.neon if drupal/core-dev is missing:

	excludePaths:
		-  */tests/src/*/*.php

What's Changed

• Support dynamic return type of Drupal\Core\Url::toString by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/255
• Support parent definition service by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/256
• Avoid false positives when PHPUnit doesn't exist. by @codebymikey in https://github.com/mglaman/phpstan-drupal/pull/216
• Fix incompatibility without drupal/core-dev by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/246

New Contributors

• @codebymikey made their first contribution in https://github.com/mglaman/phpstan-drupal/pull/216

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.1.0...1.1.1

Backwards compatibility warning

1.1.0 has introduced a breaking change in the configuration schema. See below for more information.

What's Changed

• Test drupal container related type inference by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/227
• BrowserTestBaseDefaultThemeRule false positives with UpdatePathTests by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/235
• Update branch alias in composer.json by @jibran in https://github.com/mglaman/phpstan-drupal/pull/236
• Test EntityInterface return type by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/237
• Allow magic methods for variables of type FieldItemListInterface by @eiriksm in https://github.com/mglaman/phpstan-drupal/pull/244
• Support entity query execute dynamic return type whether it is a count query or not by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/241
• Support entity class return type extension from entity storage methods by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/239
• EntityDataRepository for entity type data by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/250
• Use entity storage class inferred from entity type by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/251

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.0.3...1.1.0

Configuration changes

The drupal.entityTypeStorageMapping allowed specifying what storage classes were used for different entity types. With #239, support was added to specify what entity class an entity type uses. With #250 the way entity type information is configured has been changed.

Previously:

parameters:
	drupal:
		entityTypeStorageMapping:
			node: Drupal\node\NodeStorage
			taxonomy_term: Drupal\taxonomy\TermStorage
			user: Drupal\user\UserStorage

Now there is an entityMapping property so that we can handle future enhancements with entity type static analysis.

parameters:
	drupal:
		entityMapping:
			node:
				class: Drupal\node\Entity\Node
				storage: Drupal\node\NodeStorage
			taxonomy_term:
				class: Drupal\taxonomy\Entity\Term
				storage: Drupal\taxonomy\TermStorage
			user:
				class: Drupal\user\Entity\User
				storage: Drupal\user\UserStorage
			block:
				class: Drupal\block\Entity\Block

What's Changed

• Use isSuperTypeOf to detect if module handler by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/233

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.0.2...1.0.3

What's Changed

• Ignore defaultTheme on abstract test classes by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/230
• Only error on defaultTheme for testing profiles by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/231

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.0.1...1.0.2

What's Changed

• Fix remaining test and analysis errors by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/219
• Resolve return of ClassResolver::getInstanceFromDefinition by @brambaud in https://github.com/mglaman/phpstan-drupal/pull/220
• Handle shortcut service aliasing by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/224

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/1.0.0...1.0.1

What's Changed

• 🥳 PHPStan 1.0 by @mglaman in https://github.com/mglaman/phpstan-drupal/pull/214

Full Changelog: https://github.com/mglaman/phpstan-drupal/compare/0.12.15...1.0.0

🥳 Features:

• Dynamic return type extension for \Drupal::service #190

🥳 Features:

• Detect when deprecated services are fetched from the container #205

🛠 Task:

• Clean up PHPUnit bootstrap inclusion #203

🐞 Bug fix:

• Update ConfigEntityConfigExportRule to only run if the ConfigEntity class is annotated (not just with a phpDoc present) #200

🥳 Features:

• Verify that BrowserTestBase::$defaultTheme is populated by child class #191

🐞 Bug fix:

• Anonymous classes trigger errors with version 0.12.11 #194

This patch release adds new rules to help catch deprecations from Drupal 8 to Drupal 9 in context-aware plugins and config entities. See https://www.drupal.org/project/upgrade_status/issues/3161052

🥳 Features:

• Detect missing config_export annotation key #188
• Detect deprecated context annotation value #186

🐞 Bug fixes:

• #175: Fixes crashes on GlobalDrupalDependencyInjectionRule and autoloading when PHPUnit does not exist. Note: PHPStan still warns about autoloading and symbol discovery, still, but not crash.
• #136: Test modules weighted higher to avoid redeclares of existing functions #123.

🥳 Features:

• #174: Add dynamic file load support for module_load_include #166

#161 Fixes a type error in DrupalAutoloader on PHP 8
#157 Adds Drupal 9 testing support, including a workaround for PHPUnit 8 support (setUp(): void)

Thank you to my sponsors that make these releases possible:

• Undpaul
• Intracto