# phpcheckstyle

**Repository Path**: mirrors_linslin/phpcheckstyle

## Basic Information

- **Project Name**: phpcheckstyle
- **Description**: PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions.
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PHPCheckstyle

[![Build Status](https://travis-ci.org/PHPCheckstyle/phpcheckstyle.svg?branch=master)](https://travis-ci.org/PHPCheckstyle/phpcheckstyle)

## Overview

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.

The tool uses the PEAR Coding Standards as the default coding convention. 
But it allows you to configure it to suit your coding standards.

Please visit [https://github.com/PHPCheckstyle/phpcheckstyle/wiki](https://github.com/PHPCheckstyle/phpcheckstyle/wiki) for
more information and documentation


## Requirements

- PHP 5.0 or newer. 
- Web browser to view the checkstyle report (only for html view)
- That's all. 


## Installation

### Installation with Composer

```sh
composer require phpcheckstyle/phpcheckstyle
```

or Add `phpcheckstyle/phpcheckstyle` as a requirement to `composer.json`:

```json
{
    "require": {
        "phpcheckstyle/phpcheckstyle": "dev-master"
    }
}
```

Update your packages with `composer update` or if installing from fresh, with `composer install`.

### Manual Installation

Just download [https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip](https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip) and unzip the distribution.

```bash
$> unzip PhpCheckstyle.zip
```

This will create a directory called `phpcheckstyle` and expand all 
files in it.


### Testing with Vagrant

* install [VirtualBox](https://www.virtualbox.org/)
* install [Vagrant](https://www.vagrantup.com/)
* launch `vagrant up`  in the project root directory to start the VM

* In case of problem with the "guest additions", launch :
 
>vagrant plugin install vagrant-vbguest

* to run PHPCheckstyle on itself, type `vagrant provision --provision-with run_phpcheckstyle`
* to run PHPUnit, type `vagrant provision --provision-with run_phpunit`
* to log inside the VM, type `vagrant ssh`

## Usage

- Change directory to the PHPCheckstyle installation directory.

  ```bash
  $> cd phpcheckstyle
  ```

- Execute the `run.php` script providing the `--src` option.

  ```bash
  $> php run.php --src <php source directory/file>
  ```

- Use the `--help` option to see more options

  ```bash
  $> php run.php --help
  ```


# License
See [LICENSE](/LICENSE.txt)