Merge pull request #7976 from kenjis/fix-CLI-readline_support

docs: [CLI] make public properties deprecated
codeigniter4 · Oct 11, 2023 · 155859b · 155859b
2 parents 815b802 + dc84d18
commit 155859b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/system/CLI/CLI.php b/system/CLI/CLI.php
@@ -42,13 +42,19 @@ class CLI
      * Is the readline library on the system?
      *
      * @var bool
+     *
+     * @deprecated 4.4.2 Should be protected.
+     * @TODO Fix to camelCase in the next major version.
      */
     public static $readline_support = false;
 
     /**
      * The message displayed at prompts.
      *
      * @var string
+     *
+     * @deprecated 4.4.2 Should be protected.
+     * @TODO Fix to camelCase in the next major version.
      */
     public static $wait_msg = 'Press any key to continue...';
 
@@ -63,6 +69,8 @@ class CLI
      * Foreground color list
      *
      * @var array<string, string>
+     *
+     * @TODO Fix to camelCase in the next major version.
      */
     protected static $foreground_colors = [
         'black'        => '0;30',
@@ -88,6 +96,8 @@ class CLI
      * Background color list
      *
      * @var array<string, string>
+     *
+     * @TODO Fix to camelCase in the next major version.
      */
     protected static $background_colors = [
         'black'      => '40',

diff --git a/user_guide_src/source/changelogs/v4.4.2.rst b/user_guide_src/source/changelogs/v4.4.2.rst
@@ -32,6 +32,8 @@ Deprecations
 - **Filters:** The Auto-Discovery for Filters and ``Filters::discoverFilters()``
   is deprecated. Use :ref:`registrars` instead. See :ref:`modules-filters` for
   details.
+- **CLI:** The public property ``CLI::$readline_support`` and ``CLI::$wait_msg``
+  are deprecated. These methods will be protected.
 
 Bugs Fixed
 **********