Skip to content

Commit

Permalink
Fix up extract() doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@dereuromark
dereuromark committed Mar 14, 2019
1 parent 0e63c78 commit a510072
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 85 deletions.
11 changes: 8 additions & 3 deletions src/Shell/Task/ExtractTask.php
View file
Expand Up @@ -486,7 +486,12 @@ protected function _parse($functionName, $map)
$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 = [
Expand All @@ -496,10 +501,10 @@ protected function _parse($functionName, $map)
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);
Expand Down
14 changes: 12 additions & 2 deletions src/Utility/Text.php
View file
Expand Up @@ -499,7 +499,13 @@ public static function highlight($text, $phrase, array $options = [])
'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)) {
Expand Down Expand Up @@ -555,7 +561,7 @@ public static function stripLinks($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.
Expand All @@ -570,6 +576,10 @@ public static function tail($text, $length = 100, array $options = [])
];
$options += $default;
$exact = $ellipsis = null;
/**
* @var string $ellipsis
* @var bool $exact
*/
extract($options);

if (mb_strlen($text) <= $length) {
Expand Down
168 changes: 88 additions & 80 deletions tests/TestCase/Filesystem/FolderTest.php
View file
Expand Up @@ -1006,16 +1006,17 @@ public function testDelete()
*/
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());

Expand Down Expand Up @@ -1047,16 +1048,17 @@ public function testCopy()
*/
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());

Expand Down Expand Up @@ -1087,16 +1089,17 @@ public function testCopyWithMerge()
*/
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());

Expand Down Expand Up @@ -1164,16 +1167,17 @@ public function testCopyWithSkipFileSkipped()
*/
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());

Expand Down Expand Up @@ -1209,16 +1213,17 @@ public function testCopyWithOverwrite()
*/
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());

Expand Down Expand Up @@ -1293,16 +1298,17 @@ protected function _setupFilesystem()
*/
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());

Expand Down Expand Up @@ -1373,16 +1379,17 @@ public function testMove()
*/
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());

Expand Down Expand Up @@ -1441,16 +1448,17 @@ public function testMoveWithSkip()

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());

Expand Down

0 comments on commit a510072

Please sign in to comment.