nilportugues / php-forbidden-functions

[Git hook] Command line to look for functions that should be avoided

PHP Forbidden Functions

Why? Because someone should look for forbidden functions that should be avoided in production.

Typical examples are print_r, var_dump, exit and die function calls.

Installation

Use Composer to install the package:

$ composer require --dev nilportugues/php_forbidden

Usage

It is really this simple:

$ php bin/php_forbidden check <path/to/directory>

$ php bin/php_forbidden check <path/to/file>

You can also pipe STDIN in, if you want to use this tool with Gulp for instance:

$ cat <path/to/file> | php bin/php_forbidden check

which means that this also works writing code directly from the shell (if you have some reason to do it):

$ php bin/php_forbidden check
<?php
// Insert your code
// and press CTRL+D to send EOF

Configuration file

When run the first time, if no php_forbidden_function.yml file is found, it will be generated.

A configuration for instance, should formatted as follows:

forbidden:
  - file_get_contents
  - fopen
  - die
  - var_dump
  - print_r

You can specify an alternate location for the configuration file by passing in the -c parameter. Example:

$  php bin/php_forbidden check -c configs/php_forbidden_function.yml src/

Contribute

Contributions to the package are always welcome!

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's Git repository.

Support

Get in touch with me using one of the following means:

• Emailing me at [email protected]
• Opening an Issue

Authors

• Nil Portugués Calderó
• The Community Contributors

License

The code base is licensed under the MIT license.

php-forbidden-functions's Issues

php_forbidden_function.yml probably shouldn't be committed

As a user, if I try to modify it, I won't be able to checkout a newer release of your library because the changes would conflict/be overwritten.

A better solution is might be to add some install instructions asking users to copy the sample to .yml, or maybe a composer post-install script that copies the file for users.

Change "Fixer" name for something else

Package is not fixing, but detecting... so Fixer is not the best name

Unit tests errors on Travis CI during pull request

I made a pull request, but Travis CI is failing while running unit tests:

The command "php vendor/phpunit/phpunit/phpunit tests/" exited with 1.

How can I see what tests are being run, and where they are failing?

Exclude comments from scan

Avoid false positives by ignoring comment block comments or lines