Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spaze/phpstan-disallowed-calls
PHPStan rules to detect disallowed method & function calls, constant, namespace, attribute & superglobal usages
https://github.com/spaze/phpstan-disallowed-calls
disallowed-calls php phpstan phpstan-rules static-analysis
Last synced: about 9 hours ago
JSON representation
PHPStan rules to detect disallowed method & function calls, constant, namespace, attribute & superglobal usages
- Host: GitHub
- URL: https://github.com/spaze/phpstan-disallowed-calls
- Owner: spaze
- License: mit
- Created: 2018-06-26T01:09:59.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-14T16:24:40.000Z (8 months ago)
- Last Synced: 2024-05-15T17:30:41.672Z (8 months ago)
- Topics: disallowed-calls, php, phpstan, phpstan-rules, static-analysis
- Language: PHP
- Homepage:
- Size: 616 KB
- Stars: 212
- Watchers: 5
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Disallowed calls for PHPStan
[PHPStan](https://github.com/phpstan/phpstan) rules to detect disallowed calls and more, without running the code.
[](https://github.com/spaze/phpstan-disallowed-calls/actions?query=workflow%3A%22PHP+Tests%22)
There are some functions, methods, and constants which should not be used in production code. One good example is `var_dump()`,
it is often used to quickly debug problems but should be removed before committing the code. And sometimes it's not.
Another example would be a generic logger. Let's say you're using one of the generic logging libraries but you have your own logger
that will add some more info, or sanitize data, before calling the generic logger. Your code should not call the generic logger directly
but should instead use your custom logger.
This [PHPStan](https://github.com/phpstan/phpstan) extension will detect such usage, if configured. It should be noted that this extension
is not a way to defend against or detect hostile developers, as they can obfuscate the calls for example. This extension is meant to be
another pair of eyes, detecting your own mistakes, it doesn't aim to detect-all-the-things.
[Tests](tests) will provide examples what is ***currently*** detected. If it's not covered by tests, it might be, but most probably will not be detected.
`*Test.php` files are the tests, start with those, the analyzed test code is in [src](tests/src), required test classes in [libs](tests/libs).
Feel free to file [issues](https://github.com/spaze/phpstan-disallowed-calls/issues) or create [pull requests](https://github.com/spaze/phpstan-disallowed-calls/pulls) if you need to detect more calls.
## Installation
Install the extension using [Composer](https://getcomposer.org/):
```
composer require --dev spaze/phpstan-disallowed-calls
```
[PHPStan](https://github.com/phpstan/phpstan), the PHP Static Analysis Tool, is a requirement.
If you use [phpstan/extension-installer](https://github.com/phpstan/extension-installer), you are all set and can skip to configuration.
For manual installation, add this to your `phpstan.neon`:
```neon
includes:
- vendor/spaze/phpstan-disallowed-calls/extension.neon
```
## Configuration files
You can start with [bundled configuration files](docs/configuration-bundled.md).
## Custom rules
The extension supports versatile [custom rules](docs/custom-rules.md), too.
### Allow some previously disallowed calls or usages
Let's say you have disallowed `foo()` with custom rules. But you want to re-allow it when used in your custom wrapper, or when the first parameter equals, or not, a specified value. The extension offers multiple ways of doing that:
- [Ignore errors](docs/allow-ignore-errors.md) the PHPStan way
- [Allow in paths](docs/allow-in-paths.md)
- [Allow in methods or functions](docs/allow-in-methods.md)
- [Allow with specified parameters](docs/allow-with-parameters.md)
- [Allow with specified flags](docs/allow-with-flags.md)
[Re-allowing attributes](docs/allow-attributes.md) uses a similar [configuration](docs/allow-attributes.md).
## Disallow disabled functions & classes
Use the [provided generator](docs/disallow-disabled-functions-classes.md) to generate a configuration snippet from PHP's `disable_functions` & `disable_classes` configuration directives.
## Example output
```
------ --------------------------------------------------------
Line libraries/Report/Processor/CertificateTransparency.php
------ --------------------------------------------------------
116 Calling var_dump() is forbidden, use logger instead
------ --------------------------------------------------------
```
## Case-(in)sensitivity
Function names, method names, class names, namespaces are matched irrespective of their case (disallowing `print_r` will also find `print_R` calls), while anything else like constants, file names, paths are not.
## No other rules
You can also use this extension [without any other PHPStan rules](docs/phpstan-custom-ruleset.md). This may be useful if you want to for example check a third-party code for some calls or usage of something.
## Running tests
If you want to contribute (awesome, thanks!), you should add/run tests for your contributions.
First install dev dependencies by running `composer install`, then run PHPUnit tests with `composer test`, see `scripts` in `composer.json`. Tests are also run on GitHub with Actions on each push.
You can fix coding style issues automatically by running `composer cs-fix`.
## See also
There's a similar project with a slightly different configuration, created almost at the same time (just a few days difference): [PHPStan Banned Code](https://github.com/ekino/phpstan-banned-code).
## Framework or package-specific configurations
- For [Nette Framework](https://github.com/spaze/phpstan-disallowed-calls-nette)