Download the PHP package thecodingmachine/safe without Composer
On this page you can find all versions of the php package thecodingmachine/safe. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
More information about thecodingmachine/safe
Files in thecodingmachine/safe
Short Description PHP core functions that throw exceptions instead of returning FALSE on error
Informations about the package safe
A set of core PHP functions rewritten to throw exceptions instead of returning
false when an error is encountered.
Most PHP core functions were written before exception handling was added to the language. Therefore, most PHP functions
do not throw exceptions. Instead, they return
false in case of error.
But most of us are too lazy to check explicitly for every single return of every core PHP function.
The correct version of this code would be:
Obviously, while this snippet is correct, it is less easy to read.
Enter thecodingmachine/safe aka Safe-PHP.
Safe-PHP redeclares all core PHP functions. The new PHP functions act exactly as the old ones, except they
throw exceptions properly when an error is encountered. The "safe" functions have the same name as the core PHP
functions, except they are in the
All PHP functions that can return
false on error are part of Safe.
In addition, Safe also provide 2 'Safe' classes:
Safe\DateTimeImmutable whose methods will throw exceptions instead of returning false.
Yeah... but I must explicitly think about importing the "safe" variant of the function, for each and every file of my application. I'm sure I will forget some "use function" statements!
Fear not! thecodingmachine/safe comes with a PHPStan rule.
Never heard of PHPStan before? Check it out, it's an amazing code analyzer for PHP.
Simply install the Safe rule in your PHPStan setup (explained in the "Installation" section) and PHPStan will let you know each time you are using an "unsafe" function.
The code below will trigger this warning:
Function file_get_contents is unsafe to use. It can return FALSE instead of throwing an exception. Please add 'use function Safe\file_get_contents;' at the beginning of the file to use the variant provided by the 'thecodingmachine/safe' library.
Use composer to install Safe-PHP:
Highly recommended: install PHPStan and PHPStan extension:
Now, edit your
phpstan.neon file and add these rules:
You have a large legacy codebase and want to use "Safe-PHP" functions throughout your project? PHPStan will help you find these functions but changing the namespace of the functions one function at a time might be a tedious task.
Fortunately, Safe comes bundled with a "Rector" configuration file. Rector is a command-line tool that performs instant refactoring of your application.
Note: do not forget to replace "src/" with the path to your source directory.
Important: the refactoring only performs a "dumb" replacement of functions. It will not modify the way "false" return values are handled. So if your code was already performing error handling, you will have to deal with it manually.
Especially, you should look for error handling that was already performed, like:
This code will be refactored by Rector to:
You should then (manually) refactor it to:
Safe is loading 1000+ functions from ~85 files on each request. Yet, the performance impact of this loading is quite low.
In case you worry, using Safe will "cost" you ~700µs on each request. The performance section contains more information regarding the way we tested the performance impact of Safe.
Read the release article on TheCodingMachine's blog if you want to learn more about what triggered the development of Safe-PHP.
The files that contain all the functions are auto-generated from the PHP doc. Read the CONTRIBUTING.md file to learn how to regenerate these files and to contribute to this library.