Uploaded byOleksii Prohonnyi
PHPCS (PHP Code Sniffer)
PHP_CodeSniffer is a PHP script that detects violations of coding standards in PHP, JavaScript, and CSS files. It works by tokenizing and "sniffing" the files. A coding standard is a collection of sniff files, with each sniff file checking a single part of the standard. PHP_CodeSniffer can be installed via PEAR or Composer. It has integrations for IDEs like PHPStorm, Eclipse, and NetBeans, as well as version control systems. Popular predefined coding standards include PSR1, PSR2, PEAR, and Zend. Custom standards can be defined using a ruleset.xml or StandardNameCodingStandard.php file with sniffs placed in a StandardName/
PHPCS (PHP Code Sniffer)
- 1.
- 2. Introduction PHP_CodeSniffer is aPHP5 script that tokenises and "sniffs" PHP, JavaScript and CSS files to detect violations of a defined coding standard. A coding standard in PHP_CodeSniffer is a collection of sniff files. Each sniff file checks one part of the coding standard only.
- 3. Installation Version: 1.4.5 (stable)was released on 2013-04-04 pear install PHP_CodeSniffer (More info) php pyrus.phar install pear/PHP_CodeSniffer (More info)
- 4.
- 5. IDE integration JetBrainsPHPStorm (More info) Eclipse (More info) NetBeans (More info) Sublime Text 2 (More info)
- 6. VCS integration Git(More info) SVN (More info) Mercurial (More info)
- 7. Coding standards MySource PEAR PHPCS PSR1 PSR2 Squiz Zend
- 8. Custom coding standards Thereare 2 ways you could create your own PHPCS coding standard: using ruleset.xml file. using SigmaUkraineCodingStandard.php file.
- 9. SigmaUkraineCS: Step 1of 3 Create folder “SigmaUkraine” in main PHPCS directory. - Create folder “Sniffs” inside it. - Create SigmaUkraineCoding- Standard.php or ruleset.xml file inside it. (More info)
- 10. SigmaUkraineCS: Step 2of 3 (More info)
- 11. SigmaUkraineCS: Step 2of 3 (More info)
- 12. SigmaUkraineCS: Step 3of 3 (More info)
- 13. One more thing Standard file name should be in “<Name>CodingStandard.php” format. Sniff file name should be in “<Name>Sniff.php” format. Folder with coding standard should be named as standard itself. All sniffs should be placed to “<StandardName>Sniffs” folder. Try to name and organize sniffs due to their assignments. Each sniff should implement register() and process() methods. For warnings/errors use addWarning()/addError() methods. Look for all possible tokens in file “<PHP_CodeSniffer>Tokens.php”. Try to follow PHPCS standard in your code.
- 14.
- 15.