ubc/ctlt-coding-standard

CTLT PHP CodeSniffer Coding Standard

CTLT PHP CodeSniffer Coding Standard

A code standard based on Symfony 2 coding standards., _(*1)

Installation (Composer)

1. Install composer

2. Add the dependency to composer.json:, _(*2)

   {
       "require-dev": {
           "ubc/ctlt-coding-standard": "~1.0",
       }
   }
   

3. Install dependencies, _(*3)

   composer update, _(*4)

4. Use it, _(*5)

   phpcs --standard=vendor/ubc/ctlt-coding-standard/ruleset.xml --runtime-set installed_paths vendor/m6web/symfony2-coding-standard src/*, _(*6)

Or add the following Phing task:, _(*7)

<target name="phpcs"
    description="Find coding standard violations using PHP_CodeSniffer and print human readable output. Intended for usage on the command line before committing.">
    <phpcodesniffer standard="${vendordir}/ubc/ctlt-coding-standard/ruleset.xml">
        <config name="installed_paths" value="${vendordir}/m6web/symfony2-coding-standard"/>
        <fileset dir="${sourcedir}">
            <include name="**/*.php" />
        </fileset>
    </phpcodesniffer>
</target>

Installation (Pear)

1. Install phpcs:, _(*8)

   pear install PHP_CodeSniffer

2. Find your PEAR directory:, _(*9)

   pear config-show | grep php_dir

3. Copy, symlink or check out this repo and Symfony2 coding standard to the phpcs Standards directory:, _(*10)

   cd /path/to/pear/PHP/CodeSniffer/Standards
   git clone git://github.com/opensky/Symfony2-coding-standard.git Symfony2
   git clone git://github.com/ubc/CTLT-PHP-coding-standard.git CTLT

4. Set CTLT as your default coding standard:, _(*11)

   phpcs --config-set default_standard CTLT

5. ..., _(*12)

6. Profit!, _(*13)

   cd /path/to/my/project
   phpcs
   phpcs path/to/my/file.php