FLOW3 Ruleset

Version 12 (Andy Grunwald, 2012-04-13 23:24) → Version 13/15 (Andy Grunwald, 2012-04-14 17:38)


h1. FLOW3 Ruleset

See http://flow3.typo3.org/documentation/codingguidelines.html for reference

h3. Possible sniffs

* Namings (see http://flow3.typo3.org/documentation/codingguidelines/php.html#namespace-and-class-names)
** file names
** class/interface/exception names
** method names
** package names
** variable names
** -constant names-
* -Opening / closing PHP tag (<?php ... ?>)-
* Comments
** -inline comments (must be indented one level more than surrounding source code)-
** doc comments (all methods except constructor need @return annotation, proper @param annotations)
* -Strings-
** -quotes (single quotes to enclose literal strings)-
** -concatenation ('foo' . 'bar')-
* control structures
** -if statements (space between if and opening brace, curly braces required, else/elseif on the same line as curly braces)-
** switch statements
* Whitespaces
** -no trailing whitespace-
** -Indentation (tabs)-
** -EOL (unix style)-
* Annotations (http://flow3.typo3.org/documentation/codingguidelines/php.html#overview-of-documentation-annotations is not up-to-date anymore)
* Header (namespace declaration, license header(?), ...)
* Always === instead of == (?)