https://github.com/sstalle/php7cc

PHP 7 Compatibility Checker
https://github.com/sstalle/php7cc

Last synced: 3 days ago
JSON representation

PHP 7 Compatibility Checker

• Host: GitHub
• URL: https://github.com/sstalle/php7cc
• Owner: sstalle
• License: mit
• Created: 2015-07-25T15:08:22.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-20T19:30:35.000Z (over 6 years ago)
• Last Synced: 2024-05-17T03:43:40.597Z (4 months ago)
• Language: PHP
• Size: 272 KB
• Stars: 1,529
• Watchers: 63
• Forks: 122
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP 7 Compatibility Checker(php7cc)

#### Project status

**The project is no longer supported**. Please consider using one of the following alternatives:

* [phan](https://github.com/phan/phan)

* [phpstan](https://github.com/phpstan/phpstan)

#### Introduction

php7cc is a command line tool designed to make migration from PHP 5.3-5.6 to PHP 7 easier.

It searches for potentially troublesome statements in existing code and generates reports containing

file names, line numbers and short problem descriptions. It does not automatically fix

code to work with the new PHP version.

#### What kind of problems does it detect?

There are 2 types of issues reported by php7cc:

1. **Errors** that will definitely cause some kind of trouble (a fatal, a syntax error, a notice, etc.) on PHP 7. These are highlighted in red.

2. **Warnings** that may or may not lead to logical errors. For example, statements that are legal in both PHP 5 and PHP 7, but change their behaviour between versions fall into this category. Warnings are highlighted in yellow.    

A list of statements that may cause errors or warnings to be reported can be found in the [php-src repository](https://github.com/php/php-src/blob/PHP-7.0/UPGRADING).

***Although php7cc tries to detect as much problems as accurately as possible, sometimes 100% reliable detection

is very hard to achieve. That's why you should also run a comprehensive test suite for the code

you are going to migrate.***

# Prerequisites

To run php7cc, you need php installed, minimum required version is 5.3.3. PHP 7 is supported,

 but files with syntax errors (for example, invalid numeric literals

 or invalid UTF-8 codepoint escape sequences) can't be processed. You will only get the

 warning message about the first syntax error for such files.

 

You may also need [composer](https://getcomposer.org/) to install php7cc.

# Installation

#### Phar package

You can download a phar package for any stable version from the Github

 [releases](https://github.com/sstalle/php7cc/releases) page.

#### Composer (globally)

Make sure you have composer installed. Then execute the following command:

```bash

composer global require sstalle/php7cc

```

It is also recommended to add global Composer binaries directory to your ```PATH``` environment

variable. The location of this directory depends on the operating system you use

(see [Composer documentation](https://getcomposer.org/doc/03-cli.md#composer-home)

if you want to know more). The following command should work for some *nix systems:

```bash

export PATH="$PATH:$HOME/.config/composer/vendor/bin"

```

This makes it possible to run php7cc by entering just the executable name.

#### Composer (locally, per project)

Make sure you have composer installed. Then execute the following command from your project

directory:

```bash

composer require sstalle/php7cc --dev

```

#### Docker image

A docker image is available on [Docker Hub](https://hub.docker.com/r/ypereirareis/php7cc/)

 (contributed and maintained by [ypereirareis](https://github.com/ypereirareis)).

# Usage

Examples in this section assume that you have installed php7cc globally using composer

and that you have added it's vendor binaries directory to your ```PATH```. If this is not

the case, just substitute ```php7cc``` with the correct path to the binary of phar package.

For local per project installation the executable will be located at ```/vendor/bin/php7cc```.

#### Getting help

To see the full list of available options, run:

```bash

php7cc --help

```

#### Checking a single file or directory

To check a file or a directory, pass its name as the first argument. Directories are checked

recursively.

 

So, to check a file you could run:

```bash

php7cc /path/to/my/file.php

```

To check a directory:

```bash

php7cc /path/to/my/directory/

```

#### Specifying file extensions to check

When checking a directory, you can also specify a comma-separated list of file extensions that

should be checked. By default, only .php files are processed.

 

For example, if you want to check .php, .inc and .lib files, you could run:

```bash

php7cc --extensions=php,inc,lib /path/to/my/directory/

```

#### Excluding file or directories

You can specify a list of absolute or relative paths to exclude from checking.

Relative paths are relative to the checked directories.

So, if you want to exclude vendor and test directories, you could run:

```bash

php7cc --except=vendor --except=/path/to/my/directory/test /path/to/my/directory/

```

In this example, directories ```/path/to/my/directory/vendor```,  ```/path/to/my/directory/test``` and their contents will not be checked.

#### Specifying minimum issue level

If you set a minimum issue level, only issues having that or higher severity level will be

reported by `php7cc`. There are 3 issue levels: "info", "warning" and "error". "info" is

reserved for future use and is the same as "warning".

Example usage:

```bash

php7cc --level=error /path/to/my/directory/

```

Only errors, but not warnings will be shown in this case.

#### Specifying output format

There are two output format available: `plain` and `json`.

`output-format` command-line option, `o` in short form, can be used in order to change the output format:

```bash

php7cc -o json /path/to/my/directory/ | json_pp

```

Would output:

```json

{

   "summary" : {

      "elapsedTime" : 0.0060338973999023,

      "checkedFiles" : 3

   },

   "files" : [

      {

         "errors" : {},

         "name" : "/path/to/my/directory/myfile.php",

         "warnings" : [

            {

               "text" : "String containing number in hexadecimal notation",

               "line" : 13

            }

         ]

      },

      {

         "warnings" : [

            {

               "line" : 6,

               "text" : "Reserved name \"string\" used as a class, interface or trait name "

            }

         ],

         "name" : "/path/to/my/directory/myfile.php",

         "errors" : {}

      }

   ]

}

```

# Troubleshooting

#### Maximum function nesting level of 100/250/N reached, aborting!

You should increase maximum function nesting level in your PHP or Xdebug config file like this:

```cfg

xdebug.max_nesting_level = 1000

```

#### Allowed memory size of N bytes exhausted 

You should increase amount of memory available to CLI PHP scripts or disable PHP memory limit.

The latter can be done by setting the `memory_limit` PHP option to -1. This option can be set by editing

`php.ini` or by passing a command-line argument to PHP executable like this:

```bash

php -d memory_limit=-1 php7cc.php /path/to/my/directory

```

# Other useful links

#### Contributing

Please read the [contributing guidelines](CONTRIBUTING.md).

#### Credits

[The list of contributors](https://github.com/sstalle/php7cc/graphs/contributors) is available on the corresponding

 Github page.