Phpstan React Laravel Package
wyrihaximus/phpstan-react
PHPStan extension for ReactPHP projects that flags blocking PHP functions (e.g., file_get_contents, fopen, fread) and suggests async React alternatives from react/filesystem, react/socket, and react/stream. Include the provided ruleset to enforce non-blocking code.
ReactPHP Extension for PHPStan
Install
To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.
composer require wyrihaximus/phpstan-react
Usage
Include the rules file from the root of this package to have PHPStan check your code for blocking functions:
includes:
- vendor/wyrihaximus/phpstan-react/phpstan-reactphp-rules.neon
Functions
fclose
file_exists
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\AdapterInterface::detect
Documentation:
file_get_contents
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\Node\FileInterface::getContents
Documentation:
file_put_contents
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\Node\FileInterface::putContents
Documentation:
fopen
Relevant package(s):
- react/filesystem
- react/socket
Suggested replacement(s):
- React\Filesystem\Node\FileInterface::getContents
- React\Socket\Connector::connect
Documentation:
- https://github.com/reactphp/filesystem/?tab=readme-ov-file#getcontents
- https://reactphp.org/socket/#connect
fread
Relevant package(s):
- react/stream
Suggested replacement(s):
- React\Stream\ReadableStreamInterface::on
Documentation:
fwrite
Relevant package(s):
- react/stream
Suggested replacement(s):
- React\Stream\WritableStreamInterface::write
Documentation:
gethostbyname
Relevant package(s):
- react/dns
Suggested replacement(s):
- React\Dns\ResolverInterface::resolve
Documentation:
is_dir
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\AdapterInterface::detect
Documentation:
is_file
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\AdapterInterface::detect
Documentation:
is_link
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\AdapterInterface::detect
Documentation:
mkdir
Relevant package(s):
- react/filesystem
Suggested replacement(s):
- React\Filesystem\Node\NotExistInterface::createDirectory
Documentation:
sleep
Relevant package(s):
- react/promise-timer
Suggested replacement(s):
- React\Promise\Timer\sleep
Documentation:
time_nanosleep
Relevant package(s):
- react/promise-timer
Suggested replacement(s):
- React\Promise\Timer\sleep
Documentation:
time_sleep_until
Relevant package(s):
- react/promise-timer
Suggested replacement(s):
- React\Promise\Timer\sleep
Documentation:
usleep
Relevant package(s):
- react/promise-timer
Suggested replacement(s):
- React\Promise\Timer\sleep
Documentation:
License
The MIT License (MIT)
Copyright (c) 2024 Cees-Jan Kiewiet
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
How can I help you explore Laravel packages today?