Generic/CharacterBeforePHPOpeningTag: prevent false positive in mixed PHP/HTML files#3704
Open
jrfnl wants to merge 1 commit intosquizlabs:masterfrom
Conversation
… PHP/HTML files When a file would contain a short open echo tag `<?=` before a full PHP tag `<?php`, the sniff would throw a "The opening PHP tag must be the first content in the file" error, which IMO is a false positive. Fixed now. Includes additional tests demonstrating the issue and safeguarding the fix.
BafS
approved these changes
Nov 21, 2022
Member
|
I don't agree this is a false positive, and I think the proposed change is actually a bit confusing for this specific sniff. If the short echo represents the start of PHP code, then test file 4 is an error due to the HTML before it. If it doesn't, then test file 5 is an error as the PHP tag isn't the first thing in the file. What you're proposing is probably a logical rule for projects, but it's not what this sniff was contributed to do. It exists to ensure accidental output of HTML before PHP begins, like when a blank line is added before the opening tag accidentally and you get the error about output already having started. Maybe another sniff that enforces specific rules for mixed HTML/PHP files is required. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When a file would contain a short open echo tag
<?=before a full PHP tag<?php, the sniff would throw a "The opening PHP tag must be the first content in the file" error, which IMO is a false positive.Fixed now.
Includes additional tests demonstrating the issue and safeguarding the fix.