3.12.0 - 2025-03-18

[jrfnl]

Added

• Added support for PHP 8.4 final properties to File::getMemberProperties() through a new is_final array index in the return value. PHP 8.4 | Report final properties in File::getMemberProperties() #834
  • Thanks to Daniel Scherzer for the patch.
• Generators/HTML: each section title now has a unique anchor link, which can be copied when hovering over a title. Generators/HTML: improve anchor links  #859
  • This should make sharing a link to a specific section of the documentation more straight-forward.
  • Thanks to Juliette Reinders Folmer for the patch.
• Documentation for the following sniffs:
  • Squiz.Classes.ClassFileName
  • Squiz.Classes.ValidClassName
  • Thanks to Brian Dunne for the patches.

Changed

• PHPCBF: the messaging when no fixable errors are found will now distinguish between "No violations" (at all) versus "No fixable errors". PHPCBF: Show "No errors were found" when nothing needs to be fixed. #806
  • Thanks to Peter Wilson for the patch.
• The -h (Help) option now contains a more extensive list of "config" options which can be set. Help: update list of config options #809
  • Thanks to Juliette Reinders Folmer for the patch.
• Improved error message when invalid sniff codes are supplied to --sniffs or --exclude command line arguments. Improve error message for an invalid sniff code #344
  • Thanks to Dan Wallis for the patch.
• Improved error message when an invalid generator name is supplied to the --generator command line argument. PHP fatal error when user passes an invalid generator #709, Config: display user-friendly message when invalid generator is passed #771
  • The generator name will now also always be handled case-insensitively, independently of the OS used.
  • Thanks to Rodrigo Primo for the patch.
• The user will be shown an informative error message for sniffs missing one of the required methods. Ruleset: handle invalid sniffs more graciously #873
  • Previously this would result in a fatal error.
  • Thanks to Juliette Reinders Folmer for the patch.
• Ruleset processing will now be allowed to run to its conclusion - barring critical errors - before displaying all ruleset errors in one go. Ruleset: improve error handling #857
  • Previously an error in a ruleset would cause PHPCS to exit immediately and show only one error at a time.
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators: XML documentation files which don't contain any actual documentation will now silently be ignored. Generators: don't print documentation title if there are no docs #755
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators: when the title attribute is missing, the documentation generation will now fall back to the sniff name as the title. Generator::getTitle(): fall back to file name if title is missing #820
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators: cleaner output based on the elements of the documentation which are available. Generators: don't print standard when it's empty #819, Generators: don't print empty code comparisons/rows #821
  • Thanks to Juliette Reinders Folmer for the patch.
• Generators/HTML: improved display of code tables by using semantic HTML. Generators/HTML: improve code table semantics #854
  • Thanks to Juliette Reinders Folmer for the patch.
• Squiz.Classes.ClassFileName: recommend changing the file name instead of changing the class name. Squiz/ClassFileName: various improvements #845
  • This prevents unactionable recommendations due to the file name not translating to a valid PHP symbol name.
  • Thanks to Juliette Reinders Folmer for the patch.
• Squiz.Functions.FunctionDeclarationArgumentSpacing: incorrect spacing after a comma followed by a promoted property has an improved error message and will now be flagged with the SpacingBeforePropertyModifier or NoSpaceBeforePropertyModifier error codes. Squiz/FunctionDeclarationArgumentSpacing: handle constructor property promotion #792
  • This was previously already flagged, but using either the SpacingBeforeHint or NoSpaceBeforeHint error code, which was misleading.
  • Thanks to Juliette Reinders Folmer for the patch.
• Squiz.Functions.FunctionDeclarationArgumentSpacing: the sniff will now also check the spacing after property modifiers for promoted properties in constructor methods. Squiz/FunctionDeclarationArgumentSpacing: handle constructor property promotion #792
  • Thanks to Juliette Reinders Folmer for the patch.
• Squiz.WhiteSpace.ScopeKeywordSpacing: the sniff will now also check the spacing after the final and abstract modifier keywords. Squiz/ScopeKeywordSpacing: check spaces after abstract and final keyword #604
  • Thanks to Klaus Purer for the patch.
• The following sniff(s) have received efficiency improvements:
  • Squiz.WhiteSpace.ScopeKeywordSpacing
  • Thanks to Juliette Reinders Folmer for the patches.
• Incorrectly set inline properties (in test case files) will be silently ignored again. Remove some redundant code #884
  • This removes the Internal.PropertyDoesNotExist error code.
  • Thanks to Juliette Reinders Folmer for the patch.
• The AbstractMethodUnitTest class will now flag duplicate test case markers in a test case file. Core Tests: have a check for duplicate markers in inc files #773
  • Thanks to Juliette Reinders Folmer for the patch.
• Various housekeeping, including improvements to the tests and documentation.
  • Thanks to Asis Pattisahusiwa, Dan Wallis, Rodrigo Primo and Juliette Reinders Folmer for their contributions.

Deprecated

All deprecation are slated for removal in PHP_CodeSniffer 4.0.

• Support for sniffs not implementing the PHPCS Sniff interface. See 4.0 | Deprecate and remove support for Sniffs not implementing the PHPCS Sniff interface #694.
  • Thanks to Juliette Reinders Folmer for the patch.
• Support for including sniffs which don't comply with the PHPCS naming conventions (by referencing the sniff file directly). See 4.0 | Formally stop support for sniffs not complying with the PHPCS naming conventions #689.
  • Thanks to Juliette Reinders Folmer for the patch.
• Support for external standards named "Internal". See 4.0 | Deprecate and remove support for Standards called "Internal" #799.
  • Thanks to Juliette Reinders Folmer for the patch.
• The following Generator methods are now (soft) deprecated. See Generators: don't print documentation title if there are no docs #755:
  • PHP_CodeSniffer\Generators\Text::printTitle() in favour of PHP_CodeSniffer\Generators\Text::getFormattedTitle()
  • PHP_CodeSniffer\Generators\Text::printTextBlock() in favour of PHP_CodeSniffer\Generators\Text::getFormattedTextBlock()
  • PHP_CodeSniffer\Generators\Text::printCodeComparisonBlock() in favour of PHP_CodeSniffer\Generators\Text::getFormattedCodeComparisonBlock()
  • PHP_CodeSniffer\Generators\Markdown::printHeader() in favour of PHP_CodeSniffer\Generators\Markdown::getFormattedHeader()
  • PHP_CodeSniffer\Generators\Markdown::printFooter() in favour of PHP_CodeSniffer\Generators\Markdown::getFormattedFooter()
  • PHP_CodeSniffer\Generators\Markdown::printTextBlock() in favour of PHP_CodeSniffer\Generators\Markdown::getFormattedTextBlock()
  • PHP_CodeSniffer\Generators\Markdown::printCodeComparisonBlock() in favour of PHP_CodeSniffer\Generators\Markdown::getFormattedCodeComparisonBlock()
  • PHP_CodeSniffer\Generators\HTML::printHeader() in favour of PHP_CodeSniffer\Generators\HTML::getFormattedHeader()
  • PHP_CodeSniffer\Generators\HTML::printToc() in favour of PHP_CodeSniffer\Generators\HTML::getFormattedToc()
  • PHP_CodeSniffer\Generators\HTML::printFooter() in favour of PHP_CodeSniffer\Generators\HTML::getFormattedFooter()
  • PHP_CodeSniffer\Generators\HTML::printTextBlock() in favour of PHP_CodeSniffer\Generators\HTML::getFormattedTextBlock()
  • PHP_CodeSniffer\Generators\HTML::printCodeComparisonBlock() in favour of PHP_CodeSniffer\Generators\HTML::getFormattedCodeComparisonBlock()
  • Thanks to Juliette Reinders Folmer for the patch.

Fixed

• Fixed bug Generators: add tests covering handling of invalid docs #794 : Generators: prevent fatal error when the XML documentation does not comply with the expected format.
  • It is recommended to validate XML documentation files against the XSD file: https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Generic/ConstructorName: more defensive coding / prevent fatal error #814 : Generic.NamingConventions.ConstructorName: prevent potential fatal errors during live coding.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug File::getDeclarationName(): prevent incorrect result during live coding  #816 : File::getDeclarationName(): prevent incorrect result for unfinished closures during live coding.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/ValidClassName: bug fix - improve comment handling #817 : Squiz.Classes.ValidClassName: ignore comments when determining the name to be validated.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/ClassDeclaration: allow for function attributes #825 : Squiz.Classes.ClassDeclaration: false positives when the next thing after a class was a function with an attribute attached.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/FunctionSpacing: bug fix for attribute handling #826 : Squiz.WhiteSpace.FunctionSpacing: prevent incorrect some results when attributes are attached to a function.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug PEAR/FunctionDeclaration: prevent fixer conflict for unfinished closures/live coding #827 : PEAR.Functions.FunctionDeclaration: fixer conflict over an unfinished closure during live coding.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/MemberVarSpacing: allow for PHP 8.1+ readonly properties #828 : Squiz.WhiteSpace.MemberVarSpacing: allow for readonly properties.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/MemberVarSpacing: bug fix / improve parse error handling  #832 : Squiz.WhiteSpace.MemberVarSpacing: prevent potential fixer conflict during live coding.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/EmbeddedPhp: bug fix - fixer conflict with itself #833 : Squiz.PHP.EmbeddedPhp: fixer conflict when a PHP open tag for a multi-line snippet is found on the same line as a single-line embedded PHP snippet.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/EmbeddedPhp: bug fix - fixer conflict with itself #833 : Squiz.PHP.EmbeddedPhp: incorrect indent calculation in certain specific situations.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Generic/DisallowShortOpenTag: prevent fixer conflict #835 : Generic.PHP.DisallowShortOpenTag: don't act on parse errors.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/EmbeddedPhp: bug fix - prevent fixer conflict #838 : Squiz.PHP.EmbeddedPhp: no new line before close tag was incorrectly enforced when a preceding OO construct or function had a trailing comment after the close curly.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/MemberVarSpacing: bug fix - handling of blank lines in pre-amble  #840 : Squiz.WhiteSpace.MemberVarSpacing: more accurate reporting on blank lines in the property "pre-amble" (i.e. docblock, attributes).
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Squiz/ClassFileName: various improvements #845 : Squiz.Classes.ClassFileName: don't throw an incorrect error for an unfinished OO declaration during live coding.
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug Ruleset: bug fix - correctly handle empty array property setting #865 : Setting an array property to an empty array from an XML ruleset now works correctly.
  • Previously, the property value would be set to [0 => ''].
  • Thanks to Juliette Reinders Folmer for the patch.
• Fixed bug QA: XML doc fixes x 2 #866 : Squiz.WhiteSpace.FunctionOpeningBraceSpace: XML docs were not accessible due to an issue with the file name.
  • Thanks to Juliette Reinders Folmer for the patch.

Other

• A new wiki page is available to clarify the difference between a project ruleset and an external standard.
  • This wiki page also contains detailed information about the naming conventions external standards must comply with.
• A new XMLLint validate action runner is available which can be used in CI to validate rulesets for PHP_CodeSniffer against the XSD.

---

New Contributors

The PHP_CodeSniffer project is happy to welcome the following new contributors:
@asispts, @braindawg, @DanielEScherzer, @peterwilsoncc

Statistics

Closed: 5 issues
Merged: 74 pull requests

Follow @phpcs on Mastodon or @PHP_CodeSniffer on X to stay informed.

Please consider funding the PHP_CodeSniffer project. If you already do so: thank you!

---

This discussion was created from the release 3.12.0 - 2025-03-18.