Folder structure¶

The TYPO3 Coding Standard consists of the sniff pool and the special standard (e.g. TYPO3v4 or FLOW3). The folder TYPO3 contains the sniff pool. This is the home of all sniffs which we (re)implemented for our Coding Guidelines. This are all the shiny sniffs for the TYPO3v4 and the FLOW3 CGL.

The folder TYPO3v4 contains no sniffs but a ruleset.xml file. In this file we refer to the needed sniffs for the specified standard. So we take some shipped sniffs from PHP_CodeSniffer and our own ones from TYPO3 folder.

In both folders there are also package.xml files. This are the definition files for building PEAR packages from.

Structure:

|- CodingStandardName
   |- Sniffs
   |- Tests
   |- Builds
      |- PEAR-Package-Majorversion.Minorversion.Serviceversion.tgz
   |- ruleset.xml
   |- package.xml

Example:

|- TYPO3
|  |- Sniffs
|  |  |- Classes
|  |  |  |- LowercaseClassKeywordsSniff.php
|  |  |  |- ...
|  |  |- Commenting
|  |  |- ...
|  |- Tests
|  |  |- Classes
|  |  |- ... 
|  |- Builds
|  |  |- PHPCS_TYPO3_SniffPool-0.0.3.tgz
|  |- ruleset.xml
|  |- package.xml
|- TYPO3v4
    |- Builds
    |  |- PHPCS_TYPO3v4_Standard-0.0.3.tgz   
    |- ruleset.xml
    |- package.xml