Merge pull request #6884 from paulbalandan/is-windows

Add `is_windows()` global function

Author: paulbalandan

system/CLI/CLI.php

@@ -518,10 +518,12 @@ public static function wait(int $seconds, bool $countdown = false)
 
     /**
      * if operating system === windows
+     *
+     * @deprecated v4.3 Use `is_windows()` instead
      */
     public static function isWindows(): bool
     {
-        return PHP_OS_FAMILY === 'Windows';
+        return is_windows();
     }
 
     /**
@@ -544,7 +546,7 @@ public static function clearScreen()
     {
         // Unix systems, and Windows with VT100 Terminal support (i.e. Win10)
         // can handle CSI sequences. For lower than Win10 we just shove in 40 new lines.
-        static::isWindows() && ! static::streamSupports('sapi_windows_vt100_support', STDOUT)
+        is_windows() && ! static::streamSupports('sapi_windows_vt100_support', STDOUT)
             ? static::newLine(40)
             : static::fwrite(STDOUT, "\033[H\033[2J");
     }
@@ -691,7 +693,7 @@ public static function hasColorSupport($resource): bool
             return true;
         }
 
-        if (static::isWindows()) {
+        if (is_windows()) {
             // @codeCoverageIgnoreStart
             return static::streamSupports('sapi_windows_vt100_support', $resource)
                 || isset($_SERVER['ANSICON'])
@@ -736,7 +738,7 @@ public static function getHeight(int $default = 32): int
     public static function generateDimensions()
     {
         try {
-            if (static::isWindows()) {
+            if (is_windows()) {
                 // Shells such as `Cygwin` and `Git bash` returns incorrect values
                 // when executing `mode CON`, so we use `tput` instead
                 if (getenv('TERM') || (($shell = getenv('SHELL')) && preg_match('/(?:bash|zsh)(?:\.exe)?$/', $shell))) {

system/Common.php

@@ -691,7 +691,7 @@ function is_cli(): bool
     function is_really_writable(string $file): bool
     {
         // If we're on a Unix server we call is_writable
-        if (DIRECTORY_SEPARATOR === '/') {
+        if (! is_windows()) {
             return is_writable($file);
         }
 
@@ -721,6 +721,26 @@ function is_really_writable(string $file): bool
     }
 }
 
+if (! function_exists('is_windows')) {
+    /**
+     * Detect if platform is running in Windows.
+     */
+    function is_windows(?bool $mock = null): bool
+    {
+        static $mocked;
+
+        if (func_num_args() === 1) {
+            $mocked = $mock;
+        }
+
+        if (isset($mocked)) {
+            return $mocked;
+        }
+
+        return DIRECTORY_SEPARATOR === '\\';
+    }
+}
+
 if (! function_exists('lang')) {
     /**
      * A convenience method to translate a string or array of them and format

tests/system/CLI/CLITest.php

@@ -112,12 +112,6 @@ public function testPromptByMultipleKeys()
         PhpStreamWrapper::restore();
     }
 
-    public function testIsWindows()
-    {
-        $this->assertSame(('\\' === DIRECTORY_SEPARATOR), CLI::isWindows());
-        $this->assertSame(defined('PHP_WINDOWS_VERSION_MAJOR'), CLI::isWindows());
-    }
-
     public function testNewLine()
     {
         $this->expectOutputString('');

tests/system/Commands/GeneratorsTest.php

@@ -61,7 +61,7 @@ public function testGenerateFileOverwritten()
 
     public function testGenerateFileFailsOnUnwritableDirectory()
     {
-        if ('\\' === DIRECTORY_SEPARATOR) {
+        if (is_windows()) {
             $this->markTestSkipped('chmod does not work as expected on Windows');
         }
 

tests/system/CommonFunctionsTest.php

@@ -700,4 +700,25 @@ public function testLangOnCLI()
 
         $this->resetServices();
     }
+
+    public function testIsWindows()
+    {
+        $this->assertSame(strpos(php_uname(), 'Windows') !== false, is_windows());
+        $this->assertSame(defined('PHP_WINDOWS_VERSION_MAJOR'), is_windows());
+    }
+
+    public function testIsWindowsUsingMock()
+    {
+        is_windows(true);
+        $this->assertTrue(is_windows());
+        $this->assertNotFalse(is_windows());
+
+        is_windows(false);
+        $this->assertFalse(is_windows());
+        $this->assertNotTrue(is_windows());
+
+        is_windows(null);
+        $this->assertSame(strpos(php_uname(), 'Windows') !== false, is_windows());
+        $this->assertSame(defined('PHP_WINDOWS_VERSION_MAJOR'), is_windows());
+    }
 }

user_guide_src/source/changelogs/v4.3.0.rst

@@ -237,6 +237,7 @@ Helpers and Functions
 - You can set the locale to :php:func:`route_to()` if you pass a locale value as the last parameter.
 - Added :php:func:`request()` and :php:func:`response()` functions.
 - Added :php:func:`decamelize()` function to convert camelCase to snake_case.
+- Added :php:func:`is_windows()` global function to detect Windows platforms.
 
 Error Handling
 ==============
@@ -298,6 +299,7 @@ Deprecations
 - ``CodeIgniter::$path`` and ``CodeIgniter::setPath()`` are deprecated. No longer used.
 - The public property ``IncomingRequest::$uri`` is deprecated. It will be protected. Use ``IncomingRequest::getUri()`` instead.
 - The public property ``IncomingRequest::$config`` is deprecated. It will be protected.
+- The method ``CLI::isWindows()`` is deprecated. Use ``is_windows()`` instead.
 
 Bugs Fixed
 **********

user_guide_src/source/general/common_functions.rst

@@ -281,6 +281,19 @@ Miscellaneous Functions
     :returns: true if you can write to the file, false otherwise.
     :rtype: bool
 
+.. php:function:: is_windows([$mock = null])
+
+    :param bool|null $mock: If given and is a boolean then it will be used as the return value.
+    :rtype: bool
+
+    Detect if platform is running in Windows.
+
+    .. note:: The boolean value provided to $mock will persist in subsequent calls. To reset this
+        mock value, the user must pass an explicit ``null`` to the function call. This will
+        refresh the function to use auto-detection.
+
+    .. literalinclude:: common_functions/012.php
+
 .. php:function:: log_message($level, $message [, $context])
 
     :param   string   $level: The level of severity

user_guide_src/source/general/common_functions/012.php

@@ -0,0 +1,11 @@
+<?php
+
+is_windows(true);
+
+// some code ...
+
+if (is_windows()) {
+    // do something ..
+}
+
+is_windows(null); // reset