Home

Tchule

PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions. The tools checks the input PHP source code and reports any deviations from the coding convention.

See https://github.com/PHPCheckstyle/phpcheckstyle

Requirements

  • PHP 5.0 or newer.
  • Web browser to view the checkstyle report (for html reports)
  • That’s all

Installation

  • Just unzip the distribution.
    $> unzip phpcheckstyle.zip

Usage

  • Change directory to the PhpCheckstyle installation directory.
    $> cd PhpCheckstyle

  • Execute the run.php script providing with the --src option the directory to scan.
    $> php run.php --src <php source="" directory="" or="" file="">

  • Use the --help option to see more options or check the wiki for information on how to use with Eclipse, Hudson/Jenkins, …
    $> php run.php –help