Merge pull request #13050 from cakephp/master-extract-doc

Fix up extract() doc.

src/Shell/Task/ExtractTask.php

@@ -486,7 +486,12 @@ class ExtractTask extends Shell
                 $strings = $this->_getStrings($position, $mapCount);
 
                 if ($mapCount === count($strings)) {
-                    $singular = null;
+                    $singular = $plural = $context = null;
+                    /**
+                     * @var string $singular
+                     * @var string|null $plural
+                     * @var string|null $context
+                     */
                     extract(array_combine($map, $strings));
                     $domain = isset($domain) ? $domain : 'default';
                     $details = [
@@ -496,10 +501,10 @@ class ExtractTask extends Shell
                     if ($this->_relativePaths) {
                         $details['file'] = '.' . str_replace(ROOT, '', $details['file']);
                     }
-                    if (isset($plural)) {
+                    if ($plural !== null) {
                         $details['msgid_plural'] = $plural;
                     }
-                    if (isset($context)) {
+                    if ($context !== null) {
                         $details['msgctxt'] = $context;
                     }
                     $this->_addTranslation($domain, $singular, $details);

src/Utility/Text.php

@@ -499,7 +499,13 @@ class Text
             'limit' => -1,
         ];
         $options += $defaults;
-        $html = $format = $ellipsis = $exact = $limit = null;
+
+        $html = $format = $limit = null;
+        /**
+         * @var bool $html
+         * @var string|array $format
+         * @var int $limit
+         */
         extract($options);
 
         if (is_array($phrase)) {
@@ -555,7 +561,7 @@ class Text
      *
      * ### Options:
      *
-     * - `ellipsis` Will be used as Beginning and prepended to the trimmed string
+     * - `ellipsis` Will be used as beginning and prepended to the trimmed string
      * - `exact` If false, $text will not be cut mid-word
      *
      * @param string $text String to truncate.
@@ -570,6 +576,10 @@ class Text
         ];
         $options += $default;
         $exact = $ellipsis = null;
+        /**
+         * @var string $ellipsis
+         * @var bool $exact
+         */
         extract($options);
 
         if (mb_strlen($text) <= $length) {

tests/TestCase/Filesystem/FolderTest.php

@@ -1006,16 +1006,17 @@ class FolderTest extends TestCase
      */
     public function testCopy()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1047,16 +1048,17 @@ class FolderTest extends TestCase
      */
     public function testCopyWithMerge()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1087,16 +1089,17 @@ class FolderTest extends TestCase
      */
     public function testCopyWithSkip()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1164,16 +1167,17 @@ class FolderTest extends TestCase
      */
     public function testCopyWithOverwrite()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1209,16 +1213,17 @@ class FolderTest extends TestCase
      */
     public function testCopyWithoutRecursive()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1293,16 +1298,17 @@ class FolderTest extends TestCase
      */
     public function testMove()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1373,16 +1379,17 @@ class FolderTest extends TestCase
      */
     public function testMoveWithSkip()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());
 
@@ -1441,16 +1448,17 @@ class FolderTest extends TestCase
 
     public function testMoveWithoutRecursive()
     {
-        /** @var string $path
-         *  @var string $folderOne
-         *  @var string $folderOneA
-         *  @var string $folderTwo
-         *  @var string $folderTwoB
-         *  @var string $folderThree
-         *  @var string $fileOne
-         *  @var string $fileTwo
-         *  @var string $fileOneA
-         *  @var string $fileTwoB
+        /**
+         * @var string $path
+         * @var string $folderOne
+         * @var string $folderOneA
+         * @var string $folderTwo
+         * @var string $folderTwoB
+         * @var string $folderThree
+         * @var string $fileOne
+         * @var string $fileTwo
+         * @var string $fileOneA
+         * @var string $fileTwoB
          */
         extract($this->_setupFilesystem());