Merge remote-tracking branch 'upstream/develop' into 4.3

kenjis · kenjis · commit b85da0e7d955 · 2022-09-23T11:37:39.000+09:00
diff --git a/system/Helpers/url_helper.php b/system/Helpers/url_helper.php
@@ -74,8 +74,8 @@ function _get_uri(string $relativePath = '', ?App $config = null): URI
     /**
      * Returns a site URL as defined by the App config.
      *
-     * @param mixed    $relativePath URI string or array of URI segments
-     * @param App|null $config       Alternate configuration to use
+     * @param array|string $relativePath URI string or array of URI segments
+     * @param App|null     $config       Alternate configuration to use
      */
     function site_url($relativePath = '', ?string $scheme = null, ?App $config = null): string
     {
diff --git a/system/Log/Handlers/ChromeLoggerHandler.php b/system/Log/Handlers/ChromeLoggerHandler.php
@@ -157,7 +157,9 @@ public function sendLogs(?ResponseInterface &$response = null)
             $response = Services::response(null, true);
         }
 
-        $data = base64_encode(utf8_encode(json_encode($this->json)));
+        $data = base64_encode(
+            mb_convert_encoding(json_encode($this->json), 'UTF-8', mb_list_encodings())
+        );
 
         $response->setHeader($this->header, $data);
     }
diff --git a/system/View/Filters.php b/system/View/Filters.php
@@ -30,7 +30,7 @@ public static function capitalize(string $value): string
     /**
      * Formats a date into the given $format.
      *
-     * @param mixed $value
+     * @param int|string|null $value
      */
     public static function date($value, string $format): string
     {
@@ -48,7 +48,7 @@ public static function date($value, string $format): string
      * Example:
      *      my_date|date_modify(+1 day)
      *
-     * @param string $value
+     * @param int|string|null $value
      *
      * @return false|int
      */
@@ -62,7 +62,7 @@ public static function date_modify($value, string $adjustment)
     /**
      * Returns the given default value if $value is empty or undefined.
      *
-     * @param mixed $value
+     * @param array|bool|float|int|object|resource|string|null $value
      */
     public static function default($value, string $default): string
     {
@@ -208,15 +208,18 @@ public static function prose(string $value): string
      *  - ceil      always rounds up
      *  - floor     always rounds down
      *
-     * @param mixed $precision
+     * @param int|string $precision precision or type
      *
      * @return float|string
      */
     public static function round(string $value, $precision = 2, string $type = 'common')
     {
+        // In case that $precision is a type like `{ value1|round(ceil) }`
         if (! is_numeric($precision)) {
             $type      = $precision;
             $precision = 2;
+        } else {
+            $precision = (int) $precision;
         }
 
         switch ($type) {
diff --git a/system/View/Parser.php b/system/View/Parser.php
@@ -11,6 +11,7 @@
 
 namespace CodeIgniter\View;
 
+use CodeIgniter\Autoloader\FileLocator;
 use CodeIgniter\View\Exceptions\ViewException;
 use Config\View as ViewConfig;
 use ParseError;
@@ -72,10 +73,7 @@ class Parser extends View
     /**
      * Constructor
      *
-     * @param string          $viewPath
-     * @param mixed           $loader
-     * @param bool            $debug
-     * @param LoggerInterface $logger
+     * @param FileLocator|null $loader
      */
     public function __construct(ViewConfig $config, ?string $viewPath = null, $loader = null, ?bool $debug = null, ?LoggerInterface $logger = null)
     {
@@ -90,9 +88,6 @@ public function __construct(ViewConfig $config, ?string $viewPath = null, $loade
      *
      * Parses pseudo-variables contained in the specified template view,
      * replacing them with any data that has already been set.
-     *
-     * @param array $options
-     * @param bool  $saveData
      */
     public function render(string $view, ?array $options = null, ?bool $saveData = null): string
     {
@@ -153,9 +148,6 @@ public function render(string $view, ?array $options = null, ?bool $saveData = n
      *
      * Parses pseudo-variables contained in the specified string,
      * replacing them with any data that has already been set.
-     *
-     * @param array $options
-     * @param bool  $saveData
      */
     public function renderString(string $template, ?array $options = null, ?bool $saveData = null): string
     {
@@ -187,8 +179,8 @@ public function renderString(string $template, ?array $options = null, ?bool $sa
      * so that the variable is correctly handled within the
      * parsing itself, and contexts (including raw) are respected.
      *
-     * @param string $context The context to escape it for: html, css, js, url, raw
-     *                        If 'raw', no escaping will happen
+     * @param string|null $context The context to escape it for: html, css, js, url, raw
+     *                             If 'raw', no escaping will happen
      */
     public function setData(array $data = [], ?string $context = null): RendererInterface
     {
@@ -503,9 +495,9 @@ public function setConditionalDelimiters($leftDelimiter = '{', $rightDelimiter =
      * Handles replacing a pseudo-variable with the actual content. Will double-check
      * for escaping brackets.
      *
-     * @param mixed  $pattern
-     * @param string $content
-     * @param string $template
+     * @param array|string $pattern
+     * @param string       $content
+     * @param string       $template
      */
     protected function replaceSingle($pattern, $content, $template, bool $escape = false): string
     {
@@ -698,9 +690,9 @@ public function removePlugin(string $alias)
      * Converts an object to an array, respecting any
      * toArray() methods on an object.
      *
-     * @param mixed $value
+     * @param array|bool|float|int|object|string|null $value
      *
-     * @return mixed
+     * @return array|bool|float|int|string|null
      */
     protected function objectToArray($value)
     {
diff --git a/tests/system/Helpers/URLHelper/SiteUrlTest.php b/tests/system/Helpers/URLHelper/SiteUrlTest.php
@@ -77,8 +77,16 @@ public function testUrls($baseURL, $indexPage, $scheme, $secure, $path, $expecte
 
     public function configProvider()
     {
-        // baseURL, indexPage, scheme, path, expectedSiteUrl
+        // baseURL, indexPage, scheme, secure, path, expectedSiteUrl
         return [
+            'forceGlobalSecure' => [
+                'http://example.com/',
+                'index.php',
+                null,
+                true,
+                '',
+                'https://example.com/index.php',
+            ],
             [
                 'http://example.com/',
                 'index.php',
@@ -119,6 +127,22 @@ public function configProvider()
                 'abc',
                 'http://example.com/abc',
             ],
+            'URL decode' => [
+                'http://example.com/',
+                '',
+                null,
+                false,
+                'template/meet-%26-greet',
+                'http://example.com/template/meet-&-greet',
+            ],
+            'URL encode' => [
+                'http://example.com/',
+                '',
+                null,
+                false,
+                '<s>alert</s>',
+                'http://example.com/%3Cs%3Ealert%3C/s%3E',
+            ],
             [
                 'http://example.com/public/',
                 'index.php',
diff --git a/tests/system/Validation/RulesTest.php b/tests/system/Validation/RulesTest.php
@@ -639,4 +639,97 @@ public function requiredWithoutProvider(): Generator
             ],
         ];
     }
+
+    /**
+     * @dataProvider requiredWithoutMultipleProvider
+     */
+    public function testRequiredWithoutMultiple(string $foo, string $bar, string $baz, bool $result): void
+    {
+        $this->validation->setRules(['foo' => 'required_without[bar,baz]']);
+
+        $data = [
+            'foo' => $foo,
+            'bar' => $bar,
+            'baz' => $baz,
+        ];
+        $this->assertSame($result, $this->validation->run($data));
+    }
+
+    public function requiredWithoutMultipleProvider(): Generator
+    {
+        yield from [
+            'all empty' => [
+                '',
+                '',
+                '',
+                false,
+            ],
+            'foo is not empty' => [
+                'a',
+                '',
+                '',
+                true,
+            ],
+            'bar is not empty' => [
+                '',
+                'b',
+                '',
+                false,
+            ],
+            'baz is not empty' => [
+                '',
+                '',
+                'c',
+                false,
+            ],
+            'bar,baz are not empty' => [
+                '',
+                'b',
+                'c',
+                true,
+            ],
+        ];
+    }
+
+    /**
+     * @dataProvider requiredWithoutMultipleWithoutFieldsProvider
+     */
+    public function testRequiredWithoutMultipleWithoutFields(array $data, bool $result): void
+    {
+        $this->validation->setRules(['foo' => 'required_without[bar,baz]']);
+
+        $this->assertSame($result, $this->validation->run($data));
+    }
+
+    public function requiredWithoutMultipleWithoutFieldsProvider(): Generator
+    {
+        yield from [
+            'baz is missing' => [
+                [
+                    'foo' => '',
+                    'bar' => '',
+                ],
+                false,
+            ],
+            'bar,baz are missing' => [
+                [
+                    'foo' => '',
+                ],
+                false,
+            ],
+            'bar is not empty' => [
+                [
+                    'foo' => '',
+                    'bar' => 'b',
+                ],
+                false,
+            ],
+            'foo is not empty' => [
+                [
+                    'foo' => 'a',
+                ],
+                true,
+            ],
+        ];
+    }
 }
diff --git a/tests/system/View/ParserFilterTest.php b/tests/system/View/ParserFilterTest.php
@@ -270,13 +270,15 @@ public function testRound()
         $parser = new Parser($this->config, $this->viewsDir, $this->loader);
 
         $data = [
-            'value1' => 5.55,
+            'value1' => 5.555,
         ];
 
-        $template = '{ value1|round(1) } { value1|round(1, common) } { value1|round(ceil) } { value1|round(floor) } { value1|round(unknown) }';
+        $template = '{ value1|round(1) } / { value1|round(1, common) }'
+            . ' / { value1|round(ceil) } / { value1|round(floor) }'
+            . ' / { value1|round(unknown) }';
 
         $parser->setData($data);
-        $this->assertSame('5.6 5.6 6 5 5.55', $parser->renderString($template));
+        $this->assertSame('5.6 / 5.6 / 6 / 5 / 5.555', $parser->renderString($template));
     }
 
     public function testStripTags()
diff --git a/tests/system/View/ParserTest.php b/tests/system/View/ParserTest.php
@@ -265,6 +265,71 @@ public function testParseLoopObjectProperties()
         $this->assertSame("Super Heroes\nTom Dick Henry ", $this->parser->renderString($template));
     }
 
+    public function testParseIntegerPositive()
+    {
+        $data = [
+            'title'  => 'Count:',
+            'amount' => 5,
+        ];
+
+        $template = '{title} {amount}';
+
+        $this->parser->setData($data, 'html');
+        $this->assertSame('Count: 5', $this->parser->renderString($template));
+    }
+
+    public function testParseIntegerNegative()
+    {
+        $data = [
+            'title'  => 'Count:',
+            'amount' => -5,
+        ];
+
+        $template = '{title} {amount}';
+
+        $this->parser->setData($data, 'html');
+        $this->assertSame('Count: -5', $this->parser->renderString($template));
+    }
+
+    public function testParseFloatPositive()
+    {
+        $data = [
+            'title'  => 'Rate:',
+            'amount' => 5.5,
+        ];
+
+        $template = '{title} {amount}';
+
+        $this->parser->setData($data, 'html');
+        $this->assertSame('Rate: 5.5', $this->parser->renderString($template));
+    }
+
+    public function testParseFloatNegative()
+    {
+        $data = [
+            'title'  => 'Rate:',
+            'amount' => -5.5,
+        ];
+
+        $template = '{title} {amount}';
+
+        $this->parser->setData($data, 'html');
+        $this->assertSame('Rate: -5.5', $this->parser->renderString($template));
+    }
+
+    public function testParseNull()
+    {
+        $data = [
+            'title'  => 'Ticks:',
+            'amount' => null,
+        ];
+
+        $template = '{title} {amount}';
+
+        $this->parser->setData($data, 'html');
+        $this->assertSame('Ticks: ', $this->parser->renderString($template));
+    }
+
     public function testParseLoopEntityProperties()
     {
         $power = new class () extends Entity {
diff --git a/user_guide_src/source/libraries/validation.rst b/user_guide_src/source/libraries/validation.rst

Original file line number	Diff line number	Diff line change
`@@ -74,8 +74,8 @@ function _get_uri(string $relativePath = '', ?App $config = null): URI`
`74`	`74`	`/**`
`75`	`75`	`* Returns a site URL as defined by the App config.`
`76`	`76`	`*`
`77`		`- * @param mixed $relativePath URI string or array of URI segments`
`78`		`- * @param App\|null $config Alternate configuration to use`
	`77`	`+ * @param array\|string $relativePath URI string or array of URI segments`
	`78`	`+ * @param App\|null $config Alternate configuration to use`
`79`	`79`	`*/`
`80`	`80`	`function site_url($relativePath = '', ?string $scheme = null, ?App $config = null): string`
`81`	`81`	`{`
Original file line number	Diff line number	Diff line change
`@@ -157,7 +157,9 @@ public function sendLogs(?ResponseInterface &$response = null)`
`157`	`157`	`$response = Services::response(null, true);`
`158`	`158`	`}`
`159`	`159`
`160`		`- $data = base64_encode(utf8_encode(json_encode($this->json)));`
	`160`	`+ $data = base64_encode(`
	`161`	`+ mb_convert_encoding(json_encode($this->json), 'UTF-8', mb_list_encodings())`
	`162`	`+ );`
`161`	`163`
`162`	`164`	`$response->setHeader($this->header, $data);`
`163`	`165`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public static function capitalize(string $value): string`
`30`	`30`	`/**`
`31`	`31`	`* Formats a date into the given $format.`
`32`	`32`	`*`
`33`		`- * @param mixed $value`
	`33`	`+ * @param int\|string\|null $value`
`34`	`34`	`*/`
`35`	`35`	`public static function date($value, string $format): string`
`36`	`36`	`{`
`@@ -48,7 +48,7 @@ public static function date($value, string $format): string`
`48`	`48`	`* Example:`
`49`	`49`	`* my_date\|date_modify(+1 day)`
`50`	`50`	`*`
`51`		`- * @param string $value`
	`51`	`+ * @param int\|string\|null $value`
`52`	`52`	`*`
`53`	`53`	`* @return false\|int`
`54`	`54`	`*/`
`@@ -62,7 +62,7 @@ public static function date_modify($value, string $adjustment)`
`62`	`62`	`/**`
`63`	`63`	`* Returns the given default value if $value is empty or undefined.`
`64`	`64`	`*`
`65`		`- * @param mixed $value`
	`65`	`+ * @param array\|bool\|float\|int\|object\|resource\|string\|null $value`
`66`	`66`	`*/`
`67`	`67`	`public static function default($value, string $default): string`
`68`	`68`	`{`
`@@ -208,15 +208,18 @@ public static function prose(string $value): string`
`208`	`208`	`* - ceil always rounds up`
`209`	`209`	`* - floor always rounds down`
`210`	`210`	`*`
`211`		`- * @param mixed $precision`
	`211`	`+ * @param int\|string $precision precision or type`
`212`	`212`	`*`
`213`	`213`	`* @return float\|string`
`214`	`214`	`*/`
`215`	`215`	`public static function round(string $value, $precision = 2, string $type = 'common')`
`216`	`216`	`{`
	`217`	+ // In case that $precision is a type like `{ value1\|round(ceil) }`
`217`	`218`	`if (! is_numeric($precision)) {`
`218`	`219`	`$type = $precision;`
`219`	`220`	`$precision = 2;`
	`221`	`+ } else {`
	`222`	`+ $precision = (int) $precision;`
`220`	`223`	`}`
`221`	`224`
`222`	`225`	`switch ($type) {`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace CodeIgniter\View;`
`13`	`13`
	`14`	`+use CodeIgniter\Autoloader\FileLocator;`
`14`	`15`	`use CodeIgniter\View\Exceptions\ViewException;`
`15`	`16`	`use Config\View as ViewConfig;`
`16`	`17`	`use ParseError;`
`@@ -72,10 +73,7 @@ class Parser extends View`
`72`	`73`	`/**`
`73`	`74`	`* Constructor`
`74`	`75`	`*`
`75`		`- * @param string $viewPath`
`76`		`- * @param mixed $loader`
`77`		`- * @param bool $debug`
`78`		`- * @param LoggerInterface $logger`
	`76`	`+ * @param FileLocator\|null $loader`
`79`	`77`	`*/`
`80`	`78`	`public function __construct(ViewConfig $config, ?string $viewPath = null, $loader = null, ?bool $debug = null, ?LoggerInterface $logger = null)`
`81`	`79`	`{`
`@@ -90,9 +88,6 @@ public function __construct(ViewConfig $config, ?string $viewPath = null, $loade`
`90`	`88`	`*`
`91`	`89`	`* Parses pseudo-variables contained in the specified template view,`
`92`	`90`	`* replacing them with any data that has already been set.`
`93`		`- *`
`94`		`- * @param array $options`
`95`		`- * @param bool $saveData`
`96`	`91`	`*/`
`97`	`92`	`public function render(string $view, ?array $options = null, ?bool $saveData = null): string`
`98`	`93`	`{`
`@@ -153,9 +148,6 @@ public function render(string $view, ?array $options = null, ?bool $saveData = n`
`153`	`148`	`*`
`154`	`149`	`* Parses pseudo-variables contained in the specified string,`
`155`	`150`	`* replacing them with any data that has already been set.`
`156`		`- *`
`157`		`- * @param array $options`
`158`		`- * @param bool $saveData`
`159`	`151`	`*/`
`160`	`152`	`public function renderString(string $template, ?array $options = null, ?bool $saveData = null): string`
`161`	`153`	`{`
`@@ -187,8 +179,8 @@ public function renderString(string $template, ?array $options = null, ?bool $sa`
`187`	`179`	`* so that the variable is correctly handled within the`
`188`	`180`	`* parsing itself, and contexts (including raw) are respected.`
`189`	`181`	`*`
`190`		`- * @param string $context The context to escape it for: html, css, js, url, raw`
`191`		`- * If 'raw', no escaping will happen`
	`182`	`+ * @param string\|null $context The context to escape it for: html, css, js, url, raw`
	`183`	`+ * If 'raw', no escaping will happen`
`192`	`184`	`*/`
`193`	`185`	`public function setData(array $data = [], ?string $context = null): RendererInterface`
`194`	`186`	`{`
`@@ -503,9 +495,9 @@ public function setConditionalDelimiters($leftDelimiter = '{', $rightDelimiter =`
`503`	`495`	`* Handles replacing a pseudo-variable with the actual content. Will double-check`
`504`	`496`	`* for escaping brackets.`
`505`	`497`	`*`
`506`		`- * @param mixed $pattern`
`507`		`- * @param string $content`
`508`		`- * @param string $template`
	`498`	`+ * @param array\|string $pattern`
	`499`	`+ * @param string $content`
	`500`	`+ * @param string $template`
`509`	`501`	`*/`
`510`	`502`	`protected function replaceSingle($pattern, $content, $template, bool $escape = false): string`
`511`	`503`	`{`
`@@ -698,9 +690,9 @@ public function removePlugin(string $alias)`
`698`	`690`	`* Converts an object to an array, respecting any`
`699`	`691`	`* toArray() methods on an object.`
`700`	`692`	`*`
`701`		`- * @param mixed $value`
	`693`	`+ * @param array\|bool\|float\|int\|object\|string\|null $value`
`702`	`694`	`*`
`703`		`- * @return mixed`
	`695`	`+ * @return array\|bool\|float\|int\|string\|null`
`704`	`696`	`*/`
`705`	`697`	`protected function objectToArray($value)`
`706`	`698`	`{`