3.5.2 - 2019-10-28

• Generic.ControlStructures.DisallowYodaConditions now returns less false positives
  • False positives were being returned for array comparisions, or when performing some function calls
• Squiz.WhiteSpace.SemicolonSpacing.Incorrect error message now escapes newlines and tabs
  • Provides a clearer error message as whitespace is now visible
  • Also allows for better output for report types such as CSV and XML
• The error message for PSR12.Files.FileHeader.SpacingAfterBlock has been made clearer
  • It now uses the wording from the published PSR-12 standard to indicate that blocks must be separated by a blank line
  • Thanks to Craig Duncan for the patch
• Fixed bug #2654 : Incorrect indentation for arguments of multiline function calls
• Fixed bug #2656 : Squiz.WhiteSpace.MemberVarSpacing removes comments before first member var during auto fixing
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2663 : Generic.NamingConventions.ConstructorName complains about old constructor in interfaces
• Fixed bug #2664 : PSR12.Files.OpenTag incorrectly identifies PHP file with only an opening tag
• Fixed bug #2665 : PSR12.Files.ImportStatement should not apply to traits
• Fixed bug #2673 : PSR12.Traits.UseDeclaration does not allow comments or blank lines between use statements

3.5.1 - 2019-10-16

• Very very verbose diff report output has slightly changed to improve readability
  • Output is printed when running PHPCS with the --report=diff and -vvv command line arguments
  • Fully qualified class names have been replaced with sniff codes
  • Tokens being changed now display the line number they are on
• PSR2, PSR12, and PEAR standards now correctly check for blank lines at the start of function calls
  • This check has been missing from these standards, but has now been implemented
  • When using the PEAR standard, the error code is PEAR.Functions.FunctionCallSignature.FirstArgumentPosition
  • When using PSR2 or PSR12, the error code is PSR2.Methods.FunctionCallSignature.FirstArgumentPosition
• PSR12.ControlStructures.BooleanOperatorPlacement no longer complains when multiple expressions appear on the same line
  • Previously, boolean operators were enforced to appear at the start or end of lines only
  • Boolean operators can now appear in the middle of the line
• PSR12.Files.FileHeader no longer ignores comments preceding a use, namespace, or declare statement
• PSR12.Files.FileHeader now allows a hashbang line at the top of the file
• Fixed bug #2506 : PSR2 standard can't auto fix multi-line function call inside a string concat statement
• Fixed bug #2530 : PEAR.Commenting.FunctionComment does not support intersection types in comments
• Fixed bug #2615 : Constant visibility false positive on non-class constants
• Fixed bug #2616 : PSR12.Files.FileHeader false positive when file only contains docblock
• Fixed bug #2619 : PSR12.Files.FileHeader locks up when inline comment is the last content in a file
• Fixed bug #2621 : PSR12.Classes.AnonClassDeclaration.CloseBraceSameLine false positive for anon class passed as function argument
  • Thanks to Martins Sipenko for the patch
• Fixed bug #2623 : PSR12.ControlStructures.ControlStructureSpacing not ignoring indentation inside multi-line string arguments
• Fixed bug #2624 : PSR12.Traits.UseDeclaration doesnt apply the correct indent during auto fixing
• Fixed bug #2626 : PSR12.Files.FileHeader detects @var annotations as file docblocks
• Fixed bug #2628 : PSR12.Traits.UseDeclaration does not allow comments above a USE declaration
• Fixed bug #2632 : Incorrect indentation of lines starting with "static" inside closures
• Fixed bug #2641 : PSR12.Functions.NullableTypeDeclaration false positive when using new static()

3.5.0 - 2019-09-27

PSR-12 Standard Ready

PHP_CodeSniffer has included an in-progress PSR-12 standard since 3.3.0, but this release includes the completed standard. You can now check your code using the PSR-12 standard:

phpcs --standard=PSR12 /path/to/code

Most of the errors found can also be automatically fixed by PHPCBF:

phpcbf --standard=PSR12 /path/to/code

Changelog

• Added support for PHP 7.4 typed properties
  • The nullable operator is now tokenized as T_NULLABLE inside property types, as it is elsewhere
  • To get the type of a member var, use the File::getMemberProperties() method, which now contains a type array index
    • This contains the type of the member var, or a blank string if not specified
    • If the type is nullable, the return type will contain the leading ?
    • If a type is specified, the position of the first token in the type will be set in a type_token array index
    • If a type is specified, the position of the last token in the type will be set in a type_end_token array index
    • If the type is nullable, a nullable_type array index will also be set to TRUE
    • If the type contains namespace information, it will be cleaned of whitespace and comments in the return value
• The PSR1 standard now correctly bans alternate PHP tags
  • Previously, it only banned short open tags and not the pre-7.0 alternate tags
• Added support for only checking files that have been locally staged in a git repo
  • Use --filter=gitstaged to check these files
  • You still need to give PHPCS a list of files or directories in which to apply the filter
  • Thanks to Juliette Reinders Folmer for the contribution
• JSON reports now end with a newline character
• The phpcs.xsd schema now validates phpcs-only and phpcbf-only attributes correctly
  • Thanks to Juliette Reinders Folmer for the patch
• The tokenizer now correctly identifies inline control structures in more cases
• All helper methods inside the File class now throw RuntimeException instead of TokenizerException
  • Some tokenizer methods were also throwing RuntimeExpection but now correctly throw TokenizerException
  • Thanks to Juliette Reinders Folmer for the patch
• The File::getMethodParameters() method now returns more information, and supports closure USE groups
  • If a type hint is specified, the position of the last token in the hint will be set in a type_hint_end_token array index
  • If a default is specified, the position of the first token in the default value will be set in a default_token array index
  • If a default is specified, the position of the equals sign will be set in a default_equal_token array index
  • If the param is not the last, the position of the comma will be set in a comma_token array index
  • If the param is passed by reference, the position of the reference operator will be set in a reference_token array index
  • If the param is variable length, the position of the variadic operator will be set in a variadic_token array index
• The T_LIST token and it's opening and closing parentheses now contain references to each other in the tokens array
  • Uses the same parenthesis_opener/closer/owner indexes as other tokens
  • Thanks to Juliette Reinders Folmer for the patch
• The T_ANON_CLASS token and it's opening and closing parentheses now contain references to each other in the tokens array
  • Uses the same parenthesis_opener/closer/owner indexes as other tokens
  • Only applicable if the anon class is passing arguments to the constructor
  • Thanks to Juliette Reinders Folmer for the patch
• The PHP 7.4 T_BAD_CHARACTER token has been made available for older versions
  • Allows you to safely look for this token, but it will not appear unless checking with PHP 7.4+
• Metrics are now available for Squiz.WhiteSpace.FunctionSpacing
  • Use the info report to see blank lines before/after functions
  • Thanks to Juliette Reinders Folmer for the patch
• Metrics are now available for Squiz.WhiteSpace.MemberVarSpacing
  • Use the info report to see blank lines before member vars
  • Thanks to Juliette Reinders Folmer for the patch
• Added Generic.ControlStructures.DisallowYodaConditions sniff
  • Ban the use of Yoda conditions
  • Thanks to Mponos George for the contribution
• Added Generic.PHP.RequireStrictTypes sniff
  • Enforce the use of a strict types declaration in PHP files
• Added Generic.WhiteSpace.SpreadOperatorSpacingAfter sniff
  • Checks whitespace between the spread operator and the variable/function call it applies to
  • Thanks to Juliette Reinders Folmer for the contribution
• Added PSR12.Classes.AnonClassDeclaration sniff
  • Enforces the formatting of anonymous classes
• Added PSR12.Classes.ClosingBrace sniff
  • Enforces that closing braces of classes/interfaces/traits/functions are not followed by a comment or statement
• Added PSR12.ControlStructures.BooleanOperatorPlacement sniff
  • Enforces that boolean operators between conditions are consistently at the start or end of the line
• Added PSR12.ControlStructures.ControlStructureSpacing sniff
  • Enforces that spacing and indents are correct inside control structure parenthesis
• Added PSR12.Files.DeclareStatement sniff
  • Enforces the formatting of declare statements within a file
• Added PSR12.Files.FileHeader sniff
  • Enforces the order and formatting of file header blocks
• Added PSR12.Files.ImportStatement sniff
  • Enforces the formatting of import statements within a file
• Added PSR12.Files.OpenTag sniff
  • Enforces that the open tag is on a line by itself when used at the start of a php-only file
• Added PSR12.Functions.ReturnTypeDeclaration sniff
  • Enforces the formatting of return type declarations in functions and closures
• Added PSR12.Properties.ConstantVisibility sniff
  • Enforces that constants must have their visibility defined
  • Uses a warning instead of an error due to this conditionally requiring the project to support PHP 7.1+
• Added PSR12.Traits.UseDeclaration sniff
  • Enforces the formatting of trait import statements within a class
• Generic.Files.LineLength ignoreComments property now ignores comments at the end of a line
  • Previously, this property was incorrectly causing the sniff to ignore any line that ended with a comment
  • Now, the trailing comment is not included in the line length, but the rest of the line is still checked
• Generic.Files.LineLength now only ignores unwrappable comments when the comment is on a line by itself
  • Previously, a short unwrappable comment at the end of the line would have the sniff ignore the entire line
• Generic.Functions.FunctionCallArgumentSpacing no longer checks spacing around assignment operators inside function calls
  • Use the Squiz.WhiteSpace.OperatorSpacing sniff to enforce spacing around assignment operators
    • Note that this sniff checks spacing around all assignment operators, not just inside function calls
  • The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceBeforeEquals error has been removed
    • use Squiz.WhiteSpace.OperatorSpacing.NoSpaceBefore instead
  • The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterEquals error has been removed
    • use Squiz.WhiteSpace.OperatorSpacing.NoSpaceAfter instead
  • This also changes the PEAR/PSR2/PSR12 standards so they no longer check assignment operators inside function calls
    • They were previously checking these operators when they should not have
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.WhiteSpace.ScopeIndent no longer performs exact indents checking for chained method calls
  • Other sniffs can be used to enforce chained method call indent rules
  • Thanks to Pieter Frenssen for the patch
• PEAR.WhiteSpace.ObjectOperatorIndent now supports multi-level chained statements
  • When enabled, chained calls must be indented 1 level more or less than the previous line
  • Set the new multilevel setting to TRUE in a ruleset.xml file to enable this behaviour
  • Thanks to Marcos Passos for the patch
• PSR2.ControlStructures.ControlStructureSpacing now allows whitespace after the opening parenthesis if followed by a comment
  • Thanks to Michał Bundyra for the patch
• PSR2.Classes.PropertyDeclaration now enforces a single space after a property type keyword
  • The PSR2 standard itself excludes this new check as it is not defined in the written standard
  • Using the PSR12 standard will enforce this check
• Squiz.Commenting.BlockComment no longer requires blank line before comment if it's the first content after the PHP open tag
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Functions.FunctionDeclarationArgumentSpacing now has more accurate error messages
  • This includes renaming the SpaceAfterDefault error code to SpaceAfterEquals, which reflects the real error
• Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a reference operator
  • If you don't want this new behaviour, exclude the SpacingAfterReference error message in a ruleset.xml file
• Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a variadic operator
  • If you don't want this new behaviour, exclude the SpacingAfterVariadic error message in a ruleset.xml file
• Squiz.Functions.MultiLineFunctionDeclaration now has improved fixing for the FirstParamSpacing and UseFirstParamSpacing errors
• Squiz.Operators.IncrementDecrementUsage now suggests pre-increment of variables instead of post-increment
  • This change does not enforce pre-increment over post-increment; only the suggestion has chan...

3.4.2 - 2019-04-11

• Squiz.Arrays.ArrayDeclaration now has improved handling of syntax errors
• Fixed an issue where the PCRE JIT on PHP 7.3 caused PHPCS to die when using the parallel option
  • PHPCS now disables the PCRE JIT before running
• Fixed bug #2368 : MySource.PHP.AjaxNullComparison throws error when first function has no doc comment
• Fixed bug #2414 : Indention false positive in switch/case/if combination
• Fixed bug #2423 : Squiz.Formatting.OperatorBracket.MissingBrackets error with static
• Fixed bug #2450 : Indentation false positive when closure containing nested IF conditions used as function argument
• Fixed bug #2452 : LowercasePHPFunctions sniff failing on "new \File()"
• Fixed bug #2453 : Squiz.CSS.SemicolonSpacingSniff false positive when style name proceeded by an asterisk
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2464 : Fixer conflict between Generic.WhiteSpace.ScopeIndent and Squiz.WhiteSpace.ScopeClosingBrace when class indented 1 space
• Fixed bug #2465 : Excluding a sniff by path is not working
• Fixed bug #2467 : PHP open/close tags inside CSS files are replaced with internal PHPCS token strings when auto fixing

3.4.1 - 2019-03-19

Note for PEAR Users

The PEAR installable version of PHPCS was missing some files, which have been re-included in this release. The result of these omissions were:

• The code report was not previously available for PEAR installs
• The Generic.Formatting.SpaceBeforeCast sniff was not previously available for PEAR installs
• The Generic.WhiteSpace.LanguageConstructSpacing sniff was not previously available for PEAR installs

Thanks to Juliette Reinders Folmer for the patch

Changelog

• PHPCS will now refuse to run if any of the required PHP extensions are not loaded
  • Previously, PHPCS only relied on requirements being checked by PEAR and Composer
  • Thanks to Juliette Reinders Folmer for the patch
• Ruleset XML parsing errors are now displayed in a readable format so they are easier to correct
  • Thanks to Juliette Reinders Folmer for the patch
• The PSR2 standard no longer throws duplicate errors for spacing around FOR loop parentheses
  • Thanks to Juliette Reinders Folmer for the patch
• T_PHPCS_SET tokens now contain sniffCode, sniffProperty, and sniffPropertyValue indexes
  • Sniffs can use this information instead of having to parse the token content manually
• Added more guard code for syntax errors to various CSS sniffs
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Commenting.DocComment error messages now contain the name of the comment tag that caused the error
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.ControlStructures.InlineControlStructure now handles syntax errors correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Debug.JSHint now longer requires rhino and can be run directly from the npm install
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Files.LineEndings no longer adds superfluous new line at the end of JS and CSS files
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Formatting.DisallowMultipleStatements no longer tries fix lines containing phpcs:ignore statements
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Functions.FunctionCallArgumentSpacing now has improved performance and anonymous class support
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.WhiteSpace.ScopeIndent now respects changes to the exact property using phpcs:set mid-way through a file
  • This allows you change the exact rule for only some parts of a file
• Generic.WhiteSpace.ScopeIndent now disables exact indent checking inside all arrays
  • Previously, this was only done when using long array syntax, but it now works for short array syntax as well
• PEAR.Classes.ClassDeclaration now has improved handling of PHPCS annotations and tab indents
• PSR12.Classes.ClassInstantiation has changed it's error code from MissingParenthesis to MissingParentheses
• PSR12.Keywords.ShortFormTypeKeywords now ignores all spacing inside type casts during both checking and fixing
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Classes.LowercaseClassKeywords now examines the class keyword for anonymous classes
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.ControlStructures.ControlSignature now has improved handling of parse errors
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Commenting.PostStatementComment fixer no longer adds a blank line at the start of a JS file that begins with a comment
  • Fixes a conflict between this sniff and the Squiz.WhiteSpace.SuperfluousWhitespace sniff
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Commenting.PostStatementComment now ignores comments inside control structure conditions, such as FOR loops
  • Fixes a conflict between this sniff and the Squiz.ControlStructures.ForLoopDeclaration sniff
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Commenting.FunctionCommentThrowTag now has improved support for unknown exception types and namespaces
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.ControlStructures.ForLoopDeclaration has improved whitespace, closure, and empty expression support
  • The SpacingAfterSecondNoThird error code has been removed as part of these fixes
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.CSS.ClassDefinitionOpeningBraceSpace now handles comments and indentation correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.CSS.ClassDefinitionClosingBrace now handles comments, indentation, and multiple statements on the same line correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.CSS.Opacity now handles comments correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.CSS.SemicolonSpacing now handles comments and syntax errors correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.PHP.LowercasePHPFunctions now handles use statements, namespaces, and comments correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.WhiteSpace.FunctionSpacing now fixes function spacing correctly when a function is the first content in a file
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.WhiteSpace.SuperfluousWhitespace no longer throws errors for spacing between functions and properties in anon classes
  • Thanks to Juliette Reinders Folmer for the patch
• Zend.Files.ClosingTag no longer adds a semi-colon during fixing of a file that only contains a comment
  • Thanks to Juliette Reinders Folmer for the patch
• Zend.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2298 : PSR2.Classes.ClassDeclaration allows extended class on new line
  • Thanks to Michał Bundyra for the patch
• Fixed bug #2337 : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line function call starts on same line as open tag
• Fixed bug #2348 : Cache not invalidated when changing a ruleset included by another
• Fixed bug #2376 : Using __halt_compiler() breaks Generic.PHP.ForbiddenFunctions unless it's last in the function list
  • Thanks to Sijun Zhu for the patch
• Fixed bug #2393 : The gitmodified filter will infinitely loop when encountering deleted file paths
  • Thanks to Lucas Manzke for the patch
• Fixed bug #2396 : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line IF condition mixed with HTML
• Fixed bug #2431 : Use function/const not tokenized as T_STRING when preceded by comment

3.4.0 - 2018-12-20

Deprecations

Generic.Formatting.NoSpaceAfterCast Sniff

The Generic.Formatting.NoSpaceAfterCast sniff has been deprecated and will be removed in version 4.

The functionality of this sniff is now available in the Generic.Formatting.SpaceAfterCast sniff. Include the Generic.Formatting.SpaceAfterCast sniff and set the spacing property to 0 to retain the existing functionality. As soon as possible, replace all instances of the old sniff code with the new sniff code and property setting in your ruleset.xml files. The existing sniff will continue to work until version 4 has been released.

Other Changes

• Rule include patterns in a ruleset.xml file are now evaluated as OR instead of AND
  • Previously, a file had to match every include pattern and no exclude patterns to be included
  • Now, a file must match at least one include pattern and no exclude patterns to be included
  • This is a bug fix as include patterns are already documented to work this way
• New token T_BITWISE_NOT added for the bitwise not operator
  • This token was previously tokenized as T_NONE
  • Any sniffs specifically looking for T_NONE tokens with a tilde as the contents must now also look for T_BITWISE_NOT
  • Sniffs can continue looking for T_NONE as well as T_BITWISE_NOT to support older PHP_CodeSniffer versions
• All types of binary casting are now tokenized as T_BINARY_CAST
  • Previously, the b in b"some string with $var" would be a T_BINARY_CAST, but only when the string contained a var
  • This change ensures the b is always tokenized as T_BINARY_CAST
  • This change also converts (binary) from T_STRING_CAST to T_BINARY_CAST
  • Thanks to Juliette Reinders Folmer for the help with this patch
• Array properties set inside a ruleset.xml file can now extend a previous value instead of always overwriting it
  • e.g., if you include a ruleset that defines forbidden functions, can you now add to that list instead of having to redefine it
  • To use this feature, add extend="true" to the property tag
    • e.g., <property name="forbiddenFunctionNames" type="array" extend="true">
  • Thanks to Michael Moravec for the patch
• If $XDG_CACHE_HOME is set and points to a valid directory, it will be used for caching instead of the system temp directory
• PHPCBF now disables parallel running if you are passing content on STDIN
  • Stops an error from being shown after the fixed output is printed
• The progress report now shows files with tokenizer errors as skipped (S) instead of a warning (W)
  • The tokenizer error is still displayed in reports as normal
  • Thanks to Juliette Reinders Folmer for the patch
• The Squiz standard now ensures there is no space between an increment/decrement operator and its variable
• The File:: getMethodProperties() method now includes a has_body array index in the return value
  • FALSE if the method has no body (as with abstract and interface methods) or TRUE otherwise
  • Thanks to Chris Wilkinson for the patch
• The File::getTokensAsString() method now throws an exception if the $start param is invalid
  • If the $length param is invalid, an empty string will be returned
  • Stops an infinite loop when the function is passed invalid data
  • Thanks to Juliette Reinders Folmer for the patch
• Added new Generic.CodeAnalysis.EmptyPHPStatement sniff
  • Warns when it finds empty PHP open/close tag combinations or superfluous semicolons
  • Thanks to Juliette Reinders Folmer for the contribution
• Added new Generic.Formatting.SpaceBeforeCast sniff
  • Ensures there is exactly 1 space before a type cast, unless the cast statement is indented or multi-line
  • Thanks to Juliette Reinders Folmer for the contribution
• Added new Generic.VersionControl.GitMergeConflict sniff
  • Detects merge conflict artifacts left in files
  • Thanks to Juliette Reinders Folmer for the contribution
• Added Generic.WhiteSpace.IncrementDecrementSpacing sniff
  • Ensures there is no space between the operator and the variable it applies to
  • Thanks to Juliette Reinders Folmer for the contribution
• Added PSR12.Functions.NullableTypeDeclaration sniff
  • Ensures there is no space after the question mark in a nullable type declaration
  • Thanks to Timo Schinkel for the contribution
• A number of sniffs have improved support for methods in anonymous classes
  • These sniffs would often throw the same error twice for functions in nested classes
  • Error messages have also been changed to be less confusing
  • The full list of affected sniffs is:
    • Generic.NamingConventions.CamelCapsFunctionName
    • PEAR.NamingConventions.ValidFunctionName
    • PSR1.Methods.CamelCapsMethodName
    • PSR2.Methods.MethodDeclaration
    • Squiz.Scope.MethodScope
    • Squiz.Scope.StaticThisUsage
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.CodeAnalysis.UnusedFunctionParameter now only skips functions with empty bodies when the class implements an interface
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.CodeAnalysis.UnusedFunctionParameter now has additional error codes to indicate where unused params were found
  • The new error code prefixes are:
    • FoundInExtendedClass: when the class extends another
    • FoundInImplementedInterface: when the class implements an interface
    • Found: used in all other cases, including closures
  • The new error code suffixes are:
    • BeforeLastUsed: the unused param was positioned before the last used param in the function signature
    • AfterLastUsed: the unused param was positioned after the last used param in the function signature
  • This makes the new error code list for this sniff:
    • Found
    • FoundBeforeLastUsed
    • FoundAfterLastUsed
    • FoundInExtendedClass
    • FoundInExtendedClassBeforeLastUsed
    • FoundInExtendedClassAfterLastUsed
    • FoundInImplementedInterface
    • FoundInImplementedInterfaceBeforeLastUsed
    • FoundInImplementedInterfaceAfterLastUsed
  • These errors code make it easier for specific cases to be ignored or promoted using a ruleset.xml file
  • Thanks to Juliette Reinders Folmer for the contribution
• Generic.Classes.DuplicateClassName now inspects traits for duplicate names as well as classes and interfaces
  • Thanks to Chris Wilkinson for the patch
• Generic.Files.InlineHTML now ignores a BOM at the start of the file
  • Thanks to Chris Wilkinson for the patch
• Generic.PHP.CharacterBeforePHPOpeningTag now ignores a BOM at the start of the file
  • Thanks to Chris Wilkinson for the patch
• Generic.Formatting.SpaceAfterCast now has a setting to specify how many spaces are required after a type cast
  • Default remains 1
  • Override the spacing setting in a ruleset.xml file to change
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Formatting.SpaceAfterCast now has a setting to ignore newline characters after a type cast
  • Default remains FALSE, so newlines are not allowed
  • Override the ignoreNewlines setting in a ruleset.xml file to change
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Formatting.SpaceAfterNot now has a setting to specify how many spaces are required after a NOT operator
  • Default remains 1
  • Override the spacing setting in a ruleset.xml file to change
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Formatting.SpaceAfterNot now has a setting to ignore newline characters after the NOT operator
  • Default remains FALSE, so newlines are not allowed
  • Override the ignoreNewlines setting in a ruleset.xml file to change
  • Thanks to Juliette Reinders Folmer for the patch
• PEAR.Functions.FunctionDeclaration now checks spacing before the opening parenthesis of functions with no body
  • Thanks to Chris Wilkinson for the patch
• PEAR.Functions.FunctionDeclaration now enforces no space before the semicolon in functions with no body
  • Thanks to Chris Wilkinson for the patch
• PSR2.Classes.PropertyDeclaration now checks the order of property modifier keywords
  • This is a rule that is documented in PSR-2 but was not enforced by the included PSR2 standard until now
  • This sniff is also able to fix the order of the modifier keywords if they are incorrect
  • Thanks to Juliette Reinders Folmer for the patch
• PSR2.Methods.MethodDeclaration now checks method declarations inside traits
  • Thanks to Chris Wilkinson for the patch
• Squiz.Commenting.InlineComment now has better detection of comment block boundaries
• Squiz.Classes.ClassFileName now checks that a trait name matches the filename
  • Thanks to Chris Wilkinson for the patch
• Squiz.Classes.SelfMemberReference now supports scoped declarations and anonymous classes
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Classes.SelfMemberReference now fixes multiple errors at once, increasing fixer performance
  • Thanks to Gabriel Ostrolucký for the patch
• Squiz.Functions.LowercaseFunctionKeywords now checks abstract and final prefixes, and auto-fixes errors
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Objects.ObjectMemberComma.Missing has been renamed to Squiz.Objects.ObjectMemberComma.Found
  • The error is thrown when the comma is found but not required, so the error code was incorrect
  • If you are referencing the old error code in a ruleset XML file, please use the new code instead
  • If you wish to maintain backwards compatibility, you can provide rules for both the old and new codes
  • Thanks to Juliette Reinders Folmer f...

2.9.2 - 2018-11-07

Final 2.9 Release

Version 2.9.2 will be the final release of the PHP_CodeSniffer 2.9 branch, first released over 4 years ago. All developers still using version 2 are strongly encouraged to migrate to version 3.

Version 3 was first released as stable on the 4th of May 2017 and is a large refactoring of the code base that breaks backwards compatibility for all custom sniffs and custom reports. An upgrade guide for sniff and report developers is available here: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-3.0-Upgrade-Guide

Note: If you only use the built-in coding standards (such as PEAR or PSR2), or you have a custom ruleset.xml file that only makes use of the sniffs and reports distributed with PHP_CodeSniffer, you do not need to make any changes to begin using PHP_CodeSniffer version 3.

Other Changes

• PHPCS should now run under PHP 7.3 without deprecation warnings
  • Thanks to Nick Wilde for the patch
• Fixed bug #1496 : Squiz.Strings.DoubleQuoteUsage not unescaping dollar sign when fixing
  • Thanks to Michał Bundyra for the patch
• Fixed bug #1549 : Squiz.PHP.EmbeddedPhp fixer conflict with // comment before PHP close tag
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #1890 : Incorrect Squiz.WhiteSpace.ControlStructureSpacing.NoLineAfterClose error between catch and finally statements

3.3.2 - 2018-09-24

• Fixed a problem where the report cache was not being cleared when the sniffs inside a standard were updated
• The info report (--report=info) now has improved formatting for metrics that span multiple lines
  • Thanks to Juliette Reinders Folmer for the patch
• The unit test runner now skips .bak files when looking for test cases
  • Thanks to Juliette Reinders Folmer for the patch
• The Squiz standard now ensures underscores are not used to indicate visibility of private members vars and methods
  • Previously, this standard enforced the use of underscores
• Generic.PHP.NoSilencedErrors error messages now contain a code snippet to show the context of the error
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Arrays.ArrayDeclaration no longer reports errors for a comma on a line new after a here/nowdoc
  • Also stops a parse error being generated when auto-fixing
  • The SpaceBeforeComma error message has been changed to only have one data value instead of two
• Squiz.Commenting.FunctionComment no longer errors when trying to fix indents of multi-line param comments
• Squiz.Formatting.OperatorBracket now correctly fixes statements that contain strings
• Squiz.PHP.CommentedOutCode now ignores more @-style annotations and includes better comment block detection
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed a problem where referencing a relative file path in a ruleset XML file could add unnecessary sniff exclusions
  • This didn't actually exclude anything, but caused verbose output to list strange exclusion rules
• Fixed bug #2110 : Squiz.WhiteSpace.FunctionSpacing is removing indents from the start of functions when fixing
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2115 : Squiz.Commenting.VariableComment not checking var types when the @var line contains a comment
• Fixed bug #2120 : Tokenizer fails to match T_INLINE_ELSE when used after function call containing closure
• Fixed bug #2121 : Squiz.PHP.DisallowMultipleAssignments false positive in while loop conditions
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2127 : File::findExtendedClassName() doesn't support nested classes
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2138 : Tokenizer detects wrong token for php ::class feature with spaces
• Fixed bug #2143 : PSR2.Namespaces.UseDeclaration does not properly fix "use function" and "use const" statements
  • Thanks to Chris Wilkinson for the patch
• Fixed bug #2144 : Squiz.Arrays.ArrayDeclaration does incorrect align calculation in array with cyrillic keys
• Fixed bug #2146 : Zend.Files.ClosingTag removes closing tag from end of file without inserting a semicolon
• Fixed bug #2151 : XML schema not updated with the new array property syntax

3.3.1 - 2018-07-27

HHVM Support Dropped

Support for HHVM has been dropped due to recent unfixed bugs and HHVM's refocus on Hack only. Thanks to Walt Sorensen and Juliette Reinders Folmer for helping to remove all HHVM exceptions from the core.

Other Changes

• The full report (the default report) now has improved word wrapping for multi-line messages and sniff codes
  • Thanks to Juliette Reinders Folmer for the patch
• The summary report now sorts files based on their directory location instead of just a basic string sort
  • Thanks to Juliette Reinders Folmer for the patch
• The source report now orders error codes by name when they have the same number of errors
  • Thanks to Juliette Reinders Folmer for the patch
• The junit report no longer generates validation errors with the Jenkins xUnit plugin
  • Thanks to Nikolay Geo for the patch
• Generic.Commenting.DocComment no longer generates the SpacingBeforeTags error if tags are the first content in the docblock
  • The sniff will still generate a MissingShort error if there is no short comment
  • This allows the MissingShort error to be suppressed in a ruleset to make short descriptions optional
• Generic.Functions.FunctionCallArgumentSpacing now properly fixes multi-line function calls with leading commas
  • Previously, newlines between function arguments would be removed
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.PHP.Syntax will now use PHP_BINARY instead of trying to discover the executable path
  • This ensures that the sniff will always syntax check files using the PHP version that PHPCS is running under
  • Setting the php_path config var will still override this value as normal
  • Thanks to Willem Stuursma-Ruwen for the patch
• PSR2.Namespaces.UseDeclaration now supports commas at the end of group use declarations
  • Also improves checking and fixing for use statements containing parse errors
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.Arrays.ArrayDeclaration no longer removes the array opening brace while fixing
  • This could occur when the opening brace was on a new line and the first array key directly followed
  • This change also stops the KeyNotAligned error message being incorrectly reported in these cases
• Squiz.Arrays.ArrayDeclaration no longer tries to change multi-line arrays to single line when they contain comments
  • Fixes a conflict between this sniff and some indentation sniffs
• Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function
  • Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
• The Squiz.Classes.ValidClassName.NotCamelCaps message now references PascalCase instead of CamelCase
  • The CamelCase class name metric produced by the sniff has been changed to PascalCase class name
  • This reflects the fact that the class name check is actually a Pascal Case check and not really Camel Case
  • Thanks to Tom H Anderson for the patch
• Squiz.Commenting.InlineComment no longer enforces spacing rules when an inline comment is followed by a docblock
  • Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
• Squiz.WhiteSpace.OperatorSpacing no longer tries to fix operator spacing if the next content is a comment on a new line
  • Fixes a conflict between this sniff and the Squiz.Commenting.PostStatementComment sniff
  • Also stops PHPCS annotations from being moved to a different line, potentially changing their meaning
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.WhiteSpace.FunctionSpacing no longer checks spacing of functions at the top of an embedded PHP block
  • Fixes a conflict between this sniff and the Squiz.PHP.EmbeddedPHP sniff
  • Thanks to Juliette Reinders Folmer for the patch
• Squiz.WhiteSpace.MemberVarSpacing no longer checks spacing before member vars that come directly after methods
  • Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff
• Squiz.WhiteSpace.SuperfluousWhitespace now recognizes unicode whitespace at the start and end of a file
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2029 : Squiz.Scope.MemberVarScope throws fatal error when a property is found in an interface
  • Thanks to Juliette Reinders Folmer for the patch
• Fixed bug #2047 : PSR12.Classes.ClassInstantiation false positive when instantiating class from array index
• Fixed bug #2048 : GenericFormatting.MultipleStatementAlignment false positive when assigning values inside an array
• Fixed bug #2053 : PSR12.Classes.ClassInstantiation incorrectly fix when using member vars and some variable formats
• Fixed bug #2065 : Generic.ControlStructures.InlineControlStructure fixing fails when inline control structure contains closure
• Fixed bug #2072 : Squiz.Arrays.ArrayDeclaration throws NoComma error when array value is a shorthand IF statement
• Fixed bug #2082 : File with "defined() or define()" syntax triggers PSR1.Files.SideEffects.FoundWithSymbols
• Fixed bug #2095 : PSR2.Namespaces.NamespaceDeclaration does not handle namespaces defined over multiple lines

3.3.0 - 2018-06-07

Deprecations

Squiz.WhiteSpace.LanguageConstructSpacing Sniff

The Squiz.WhiteSpace.LanguageConstructSpacing sniff has been deprecated and will be removed in version 4.

The sniff has been moved to the Generic standard, with a new code of Generic.WhiteSpace.LanguageConstructSpacing. The new Generic sniff now also checks many more language constructs to enforce additional spacing rules. The existing Squiz sniff will continue to work until version 4 has been released. Thanks to Mponos George for the contribution.

As soon as possible, replace all instances of the old sniff code with the new sniff code in your ruleset.xml files.

Setting Array Properties

The current method for setting array properties in ruleset files has been deprecated and will be removed in version 4.

Currently, setting an array value uses the string syntax print=>echo,create_function=>null. Now, individual array elements are specified using a new element tag with key and value attributes.

For example, the following array of forbidden functions:

<property name="forbiddenFunctions" type="array" value="sizeof=>count,delete=>unset,print=>echo,is_null=>null,create_function=>null"/>

Will be rewritten using this format:

<property name="forbiddenFunctions" type="array">
    <element key="sizeof" value="count"/>
    <element key="delete" value="unset"/>
    <element key="print" value="echo"/>
    <element key="is_null" value="null"/>
    <element key="create_function" value="null"/>
</property>

Thanks to Michał Bundyra for the patch.

T_ARRAY_HINT Token

The T_ARRAY_HINT token has been deprecated and will be removed in version 4.

The token was used to ensure array type hints were not tokenized as T_ARRAY, but no other type hints were given a special token. Array type hints now use the standard T_STRING token instead.

Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_ARRAY_HINT tokens.

T_RETURN_TYPE Token

The T_RETURN_TYPE token has been deprecated and will be removed in version 4.

The token was used to ensure array/self/parent/callable return types were tokenized consistently. But for namespaced return types, only the last part of the string (the class name) was tokenized as T_RETURN_TYPE. This was not consistent and so return types are now left using their original token types so they are not skipped by sniffs. The exception are array return types, which are tokenized as T_STRING instead of T_ARRAY, as they are used for type hints.

Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_RETUTN_TYPE tokens.

To get the return type of a function, use the File::getMethodProperties() method, which now contains a return_type array index. This index contains the return type of the function or closer, or a blank string if not specified. If the return type is nullable, the return type will contain the leading ? and a nullable_return_type array index in the return value will also be set to true. If the return type contains namespace information, it will be cleaned of whitespace and comments. To access the original return value string, use the main tokens array.

PSR-12 Standard In-Progress

This release contains an incomplete version of the PSR-12 coding standard. Errors found using this standard should be valid, but it will miss a lot of violations until it is complete. If you'd like to test and help, you can use the standard by running PHPCS with --standard=PSR12

Other Changes

• Config values set using --runtime-set now override any config values set in rulesets or the CodeSniffer.conf file
• You can now apply include-pattern rules to individual message codes in a ruleset like you can with exclude-pattern rules
  • Previously, include-pattern rules only applied to entire sniffs
  • If a message code has both include and exclude patterns, the exclude patterns will be ignored
• Using PHPCS annotations to selectively re-enable sniffs is now more flexible
  • Previously, you could only re-enable a sniff/category/standard using the exact same code that was disabled
  • Now, you can disable a standard and only re-enable a specific category or sniff
  • Or, you can disable a specific sniff and have it re-enable when you re-enable the category or standard
• The value of array sniff properties can now be set using phpcs:set annotations
  • e.g., phpcs:set Standard.Category.SniffName property[] key=>value,key2=>value2
  • Thanks to Michał Bundyra for the patch
• PHPCS annotations now remain as T_PHPCS_* tokens instead of reverting to comment tokens when --ignore-annotations is used
  • This stops sniffs (especially commenting sniffs) from generating a large number of false errors when ignoring
  • Any custom sniffs that are using the T_PHPCS_* tokens to detect annotations may need to be changed to ignore them
    • Check $phpcsFile->config->annotations to see if annotations are enabled and ignore when false
• You can now use fully or partially qualified class names for custom reports instead of absolute file paths
  • To support this, you must specify an autoload file in your ruleset.xml file and use it to register an autoloader
  • Your autoloader will need to load your custom report class when requested
  • Thanks to Juliette Reinders Folmer for the patch
• The JSON report format now does escaping in error source codes as well as error messages
  • Thanks to Martin Vasel for the patch
• Invalid installed_paths values are now ignored instead of causing a fatal error
• Improved testability of custom rulesets by allowing the installed standards to be overridden
  • Thanks to Timo Schinkel for the patch
• The key used for caching PHPCS runs now includes all set config values
  • This fixes a problem where changing config values (e.g., via --runtime-set) used an incorrect cache file
• The "Function opening brace placement" metric has been separated into function and closure metrics in the info report
  • Closures are no longer included in the "Function opening brace placement" metric
  • A new "Closure opening brace placement" metric now shows information for closures
• Multi-line T_YIELD_FROM statements are now replicated properly for older PHP versions
• The PSR2 standard no longer produces 2 error messages when the AS keyword in a foreach loop is not lowercase
• Specifying a path to a non-existent dir when using the --report-[reportType]=/path/to/report CLI option no longer throws an exception
  • This now prints a readable error message, as it does when using --report-file
• The File::getMethodParamaters() method now includes a type_hint_token array index in the return value
  • Provides the position in the token stack of the first token in the type hint
• The File::getMethodProperties() method now includes a return_type_token array index in the return value
  • Provides the position in the token stack of the first token in the return type
• The File::getTokensAsString() method can now optionally return original (non tab-replaced) content
  • Thanks to Juliette Reinders Folmer for the patch
• Removed Squiz.PHP.DisallowObEndFlush from the Squiz standard
  • If you use this sniff and want to continue banning ob_end_flush(), use Generic.PHP.ForbiddenFunctions instead
  • You will need to set the forbiddenFunctions property in your ruleset.xml file
• Removed Squiz.PHP.ForbiddenFunctions from the Squiz standard
  • Replaced by using the forbiddenFunctions property of Generic.PHP.ForbiddenFunctions in the Squiz ruleset.xml
  • Functionality of the Squiz standard remains the same, but the error codes are now different
  • Previously, Squiz.PHP.ForbiddenFunctions.Found and Squiz.PHP.ForbiddenFunctions.FoundWithAlternative
  • Now, Generic.PHP.ForbiddenFunctions.Found and Generic.PHP.ForbiddenFunctions.FoundWithAlternative
• Added new Generic.PHP.LowerCaseType sniff
  • Ensures PHP types used for type hints, return types, and type casting are lowercase
  • Thanks to Juliette Reinders Folmer for the contribution
• Added new Generic.WhiteSpace.ArbitraryParenthesesSpacing sniff
  • Generates an error for whitespace inside parenthesis that don't belong to a function call/declaration or control structure
  • Generates a warning for any empty parenthesis found
  • Allows the required spacing to be set using the spacing sniff property (default is 0)
  • Allows newlines to be used by setting the ignoreNewlines sniff property (default is false)
  • Thanks to Juliette Reinders Folmer for the contribution
• Added new PSR12.Classes.ClassInstantiation sniff
  • Ensures parenthesis are used when instantiating a new class
• Added new PSR12.Keywords.ShortFormTypeKeywords sniff
  • Ensures the short form of PHP types is used when type casting
• Added new PSR12.Namespaces.CompundNamespaceDepth sniff
  • Ensures compound namespace use statements have a max depth of 2 levels
  • The max depth can be changed by setting the 'maxDepth' sniff property in a ruleset.xml file
• Added new PSR12.Operators.OperatorSpacing sniff
  • Ensures operators are preceded and followed by at least 1 space
• Improved core support for grouped property declarations
  • Also improves support in Squiz.WhiteSpace.ScopeKeywordSpacing and Squiz.WhiteSpace.MemberVarSpacing
  • Thanks to Juliette Reinders Folmer for the patch
• Generic.Commenting.DocComment now produces a NonParamGroup error when tags are mixed in with the @param tag group
  • It would previously throw either a NonParamGroup or ParamGroup error depending on the order of tags
  • This change allows the NonParamGroup error to be suppressed in a ruleset to allow the @param group to contain other tags
  • Thanks to Phil Davis f...