Remove some redundant code #884
Merged
+1
−26
Conversation
This file contains 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
With the `MessageCollector` being used in the `Ruleset` class since PR 857, some guard code as introduced in 99 is no longer needed. The guard code was in place to prevent the following situation: * File under test contained an invalid `// phpcs:set` annotation which tried to set a non-existent property on a sniff. * The `File::process()` method would see this annotation and call the `Ruleset::setSniffProperty()` method to set the property. * The `Ruleset::setSniffProperty()` method would throw an exception for the non-existent property. * The exception would cause the `File` class to stop scanning the file, potentially leading to missing errors/warnings. As the error for setting a non-existent property now no longer leads to an exception on a direct call to the `Ruleset::setSniffProperty()` method, we also no longer need to catch the exception and handle it from within the `File::process()` method. In practice, this means that setting a non-existent property on a sniff via an inline `// phpcs:set` annotation will now be silently ignored (again) and will not affect the scan of the rest of the file. This commit reverts 99.
fredden
approved these changes
Mar 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
With the
MessageCollectorbeing used in theRulesetclass since PR #857, some guard code as introduced in #99 is no longer needed.The guard code was in place to prevent the following situation:
// phpcs:setannotation which tried to set a non-existent property on a sniff.File::process()method would see this annotation and call theRuleset::setSniffProperty()method to set the property.Ruleset::setSniffProperty()method would throw an exception for the non-existent property.Fileclass to stop scanning the file, potentially leading to missing errors/warnings.As the error for setting a non-existent property now no longer leads to an exception on a direct call to the
Ruleset::setSniffProperty()method, we also no longer need to catch the exception and handle it from within theFile::process()method.In practice, this means that setting a non-existent property on a sniff via an inline
// phpcs:setannotation will now be silently ignored (again) and will not affect the scan of the rest of the file.This commit reverts #99.
Suggested changelog entry
N/A