MVLabs Coding Standards for php-cs

This is a custom sniff for PHP_CodeSniffer that tries to allow the use of PSR-2 standards together with the newer PHP 7 features.

• Prerequisities
• Install
• Usage
• Sniffers

Prerequisites

PHP version 5.1.2 or greater.

Install

Add this repository to your project composer.json:

"repositories": [
        {
            "url": "https://git.mvlabs.it/internals/coding-standard.git",
            "type": "git"
        }
    ]

require the package in your dev dependencies:

php composer.phar require --dev mvlabs/coding-standard:dev-master

Usage

You should copy the template vendor/mvlabs/code-standard/phpcs.xml.dist in your root directory with the name phpcs.xml, edit it accordingly, and set your code sniffer to read rules from there:

If you run PHP_CodeSniffer without specifying a coding standard, PHP_CodeSniffer will look in the current directory and all parent directories for a file called phpcs.xml, so it will automatically adapt to the new standard.

If you use an IDE you have to configure it accordingly: In PHP Storm you should go in File -> Settings -> Editor -> Inspections -> PHP -> PHP Code Sniffer Validation -> Coding Standard from the dropdown menu select Custom and then point to the phpcs.xml file in your project.

Sniffers

MultiLineDeclarationSniffer:

This sniffer do everything the Squiz Sniffer with the same name does, but it supports the return type of PHP 7 in a multiline function declaration, with the following syntax:

    private function functionName(
        string $param1,
        string $param2
    ): string
    {
        //function body
    }

If the multiline function declaration has a return type:

1. The closing parenthesis of the arguments must be on a new line
2. There must be no space between the closing parenthesis and the colon
3. There must be a single space between the colon and the return type
4. There must be a new line between the return type and the opening curly brace of the body function declaration

FunctionDeclarationSniff:

As the previous one, this do everything the Squiz Sniffer does, but it allows for method names to be called new() without giving a warning.