Yii PHP Framework Version 2 - Coding standard tools
Fund package maintenance!
Installs: 460 267
This repository contains settings for Yii2 coding style for various tools.
You can get code style definition using one of the following methods.
$ git clone git://github.com/yiisoft/yii2-coding-standards.git
$ curl -sS https://getcomposer.org/installer | php
Or if your system doesn't have CURL installed:
$ php -r "eval('?>'.file_get_contents('https://getcomposer.org/installer'));"
- Set up all dependencies declared in
$ php composer.phar install
PHP_CodeSniffer coding standard, rule set and sniff token parsing classes for the Yii 2 Web Framework. Overally rules are based on PSR-2 standard with some minor exceptions and changes. Rules derived from PSR-2 standard and excluded in Yii2 standard were implemented (or planned to be) as sniff classes.
Rules could also be used for checking code style of an existing Yii2 applications.
Everything that is merged into main Yii2 development repository being checked with these rule set as well.
Using code style
After CodeSniffer is installed you can launch it with custom code style using the following syntax:
$ ./vendor/bin/phpcs --extensions=php --standard=Yii2 /home/resurtm/work/Yii2MegaApp/
If you're using PhpStorm you can configure it to use CodeSniffer using Settings → PHP → Code Sniffer. Yii2 code style can be specified at Inspections → PHP → PHP Code Sniffer validation.
Yii uses PSR-1 and PSR-2 as code style standards. You can choose these via
Code Style →
Set from... →
Predefined Style →
Feel free to request additional features, submit bugs and problems.
Thank you for choosing Yii Framework!