Modernize: add constant visibility #1051
Merged
Conversation
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
Constant visibility is available in PHP since PHP 7.1. This commit adds the visibility to all class constants currently in the codebase and starts enforcing constant visibility being required.
In most cases, the visibility remains the same as before, i.e. `public`, however, there are a couple of exceptions, which could be considered a breaking change:
* `PHP_CodeSniffer\Generators\HTML::STYLESHEET` (was `public`, now `private`)
- Even though the class is not `final`, the `Config` only allows for requesting a PHPCS native `Generator` class, so the chances of the class being extended are very slim.
- On top of that, this was a function local variable until a few months ago, so chances of any external access to the constant being active are also slim based on the timing.
* `PHP_CodeSniffer\Util\Timing::MINUTE_IN_MS` and `PHP_CodeSniffer\Util\Timing::SECOND_IN_MS` (were `public`, now `private`)
- These properties were introduced about six months ago and only ever intended for use by the class itself.
Aside from the above, there are some visibility changes for class constants which are part of the PHPCS native test suite, so not in the public API.
|
Rebased without changes to get past the merge conflict. Merging once the build has passed. |
jrfnl
force-pushed
the
phpcs-4.0/feature/constant-visibility
branch
from
02ebd35 to
bdaf11b
Compare
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
Constant visibility is available in PHP since PHP 7.1. This commit adds the visibility to all class constants currently in the codebase and starts enforcing constant visibility being required.
In most cases, the visibility remains the same as before, i.e.
public, however, there are a couple of exceptions, which could be considered a breaking change:PHP_CodeSniffer\Generators\HTML::STYLESHEET(waspublic, nowprivate)final, theConfigonly allows for requesting a PHPCS nativeGeneratorclass, so the chances of the class being extended are very slim.PHP_CodeSniffer\Util\Timing::MINUTE_IN_MSandPHP_CodeSniffer\Util\Timing::SECOND_IN_MS(werepublic, nowprivate)Aside from the above, there are some visibility changes for class constants which are part of the PHPCS native test suite, so not in the public API.
Suggested changelog entry
Changed:
PHP_CodeSniffer\Generators\HTML::STYLESHEET,PHP_CodeSniffer\Util\Timing::MINUTE_IN_MSandPHP_CodeSniffer\Util\Timing::SECOND_IN_MSclass constants are no longerpublic.