3f/lint

Lint is a wrapper to `PHP -l` command.

, _(*1)

Lint

Lint is a wrapper to php -l command., _(*2)

Composer Installation

To install Lint, you first need to install Composer, a Package Manager for PHP, following those few steps:, _(*3)

curl -s https://getcomposer.org/installer | php

You can run this command to easily access composer from anywhere on your system:, _(*4)

sudo mv composer.phar /usr/local/bin/composer

Lint Installation

Once you have installed Composer, it's easy install Lint., _(*5)

1. Edit your composer.json file, adding Lint to the require section:

{
    "require": {
        "3f/lint": "dev-master"
    },
}

1. Run the following command in your project root dir:

composer update

Usage

Lint provides two static methods only: checkSourceFile() and checkSourceCode():, _(*6)

Lint::checkSourceFile("foo.php");

Methods

Lint::checkSourceFile()

public static function checkSourceFile(
    $fileName
)

Makes the syntax check of the specified file. If an error occurs, generates an exception., _(*7)

Parameters, _(*8)

• fileName, _(*9)

  The file name you want check., _(*10)

Exceptions, _(*11)

• RuntimeException, _(*12)

  In case of error it raises an exception., _(*13)

Lint::checkSourceCode()

public static function checkSourceCode(
    $str,
    $addTags = TRUE
)

Makes the syntax check of the given source code. If an error occurs, generates an exception., _(*14)

Parameters, _(*15)

• str, _(*16)

  The source code., _(*17)

• addTags, _(*18)

  Tells if you want add PHP tags to the source code, because PHP lint needs them or it will raise an exception., _(*19)

Exceptions, _(*20)

• RuntimeException, _(*21)

  In case of error it raises an exception., _(*22)

Documentation

The documentation can be generated using Doxygen. A Doxyfile is provided for your convenience., _(*23)

Requirements

• PHP 5.4.0 or above.

Authors

Filippo F. Fadda - filippo.fadda@programmazione.it - http://www.linkedin.com/in/filippofadda, _(*24)

License

Lint is licensed under the Apache License, Version 2.0 - see the LICENSE file for details., _(*25)