docs: [CLI] make public properties deprecated #7976
Merged
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
mostafakhudair
suggested changes
Sep 28, 2023
system/CLI/CLI.php
Outdated
Comment on lines
45
to
49
| * | ||
| * @deprecated 4.4.2 Should be protected. | ||
| */ | ||
| public static $readline_support = false; | ||
|
|
There was a problem hiding this comment.
Suggested change
| * | |
| * @deprecated 4.4.2 Should be protected. | |
| */ | |
| public static $readline_support = false; | |
| * | |
| * @deprecated 4.4.2 it will be removed and replaced with | |
| * the protected property `CLI::$readlineSupport`. | |
| */ | |
| public static $readline_support = false; | |
| protected static $readlineSupport = false; | |
There was a problem hiding this comment.
The property name is not good, but I don't have a plan to change it.
The future is uncertain.
system/CLI/CLI.php
Outdated
Comment on lines
55
to
57
| * @deprecated 4.4.2 Should be protected. | ||
| */ | ||
| public static $wait_msg = 'Press any key to continue...'; |
There was a problem hiding this comment.
Suggested change
| * @deprecated 4.4.2 Should be protected. | |
| */ | |
| public static $wait_msg = 'Press any key to continue...'; | |
| * @deprecated 4.4.2 it will be removed and replaced with | |
| * the protected property `CLI::$waitingMessage`. | |
| */ | |
| public static $wait_msg = 'Press any key to continue...'; | |
| protected static $waitingMessage = 'Press any key to continue...'; |
Comment on lines
31
to
32
| - The public property ``CLI::$readline_support`` and ``CLI::$wait_msg`` are | ||
| deprecated. These methods will be protected. |
There was a problem hiding this comment.
Suggested change
| - The public property ``CLI::$readline_support`` and ``CLI::$wait_msg`` are | |
| deprecated. These methods will be protected. | |
| - The public property ``CLI::$readline_support`` is deprecated, and it | |
| will be replaced with the protected property ``CLI::$readlineSupport`. | |
| - The public property ``CLI::$wait_msg`` is deprecated, and it will | |
| be replaced with the protected property ``CLI::$waitingMessage`. |
MGatner
approved these changes
Oct 10, 2023
There was a problem hiding this comment.
I like @mostafakhudair 's suggestions but since this class isn't final they introduce another layer of breaking changes. Consider for next major version.
No need to be public.
kenjis
force-pushed
the
fix-CLI-readline_support
branch
from
f271c3b to
1c5ff8d
Compare
|
@mostafakhudair @MGatner I added |
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
No need to be public.
Checklist: