feature: 增加 Pinyin::polyphonesAsArray. fixed #195

overtrue · Jun 12, 2023 · 768d947 · 768d947
1 parent 50d3ce9
commit 768d947
Show file tree

Hide file tree

Showing 5 changed files with 79 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -124,7 +124,7 @@ Pinyin::passportName('律师'); // ['lyu', 'shi']
 
 ### 多音字
 
-多音字的返回值为关联数组的集合：
+多音字的返回值为关联数组的集合，默认返回去重后的所有读音：
 
 ```php
 $pinyin = Pinyin::polyphones('重庆');
@@ -139,12 +139,29 @@ $pinyin->toArray();
 // ]
 ```
 
+如果不想要去重，可以数组形式返回：
+
+```php
+$pinyin = Pinyin::polyphones('重庆重庆', Converter::TONE_STYLE_SYMBOL, true);
+
+// or 
+$pinyin = Pinyin::polyphonesAsArray('重庆重庆', Converter::TONE_STYLE_SYMBOL);
+
+$pinyin->toArray();
+// [
+//     ["重" => ["zhòng", "chóng", "tóng"]],
+//     ["庆" => ["qìng"]],
+//     ["重" => ["zhòng", "chóng", "tóng"]],
+//     ["庆" => ["qìng"]]
+// ]
+```
+
 ### 单字转拼音
 
 和多音字类似，单字的返回值为字符串，多音字将根据该字字频调整得到常用音：
 
 ```php
-$pinyin = Pinyin::polyphones('重庆');
+$pinyin = Pinyin::chars('重庆');
 
 echo $pinyin['重']; // "zhòng"
 echo $pinyin['庆']; // "qìng"

diff --git a/src/Converter.php b/src/Converter.php
@@ -20,6 +20,8 @@ class Converter
 
     protected bool $polyphonic = false;
 
+    protected bool $polyphonicAsList = false;
+
     protected bool $asSurname = false;
 
     protected bool $noWords = false;
@@ -53,9 +55,10 @@ public static function make(): static
         return new static();
     }
 
-    public function polyphonic(): static
+    public function polyphonic(bool $asList = false): static
     {
         $this->polyphonic = true;
+        $this->polyphonicAsList = $asList;
 
         return $this;
     }
@@ -196,7 +199,13 @@ public function convertAsChars(string $string, bool $polyphonic = false): Collec
         foreach ($chars as $char) {
             if (isset($map[$char])) {
                 if ($polyphonic) {
-                    $items[$char] = \array_map(fn ($pinyin) => $this->formatTone($pinyin, $this->toneStyle), $map[$char]);
+                    $pinyin = \array_map(fn ($pinyin) => $this->formatTone($pinyin, $this->toneStyle), $map[$char]);
+                    if ($this->polyphonicAsList) {
+                        $items[] = [$char => $pinyin];
+                    } else {
+                        $items[$char] = $pinyin;
+                    }
+
                 } else {
                     $items[$char] = $this->formatTone($map[$char][0], $this->toneStyle);
                 }

diff --git a/src/Pinyin.php b/src/Pinyin.php
@@ -5,7 +5,6 @@
 use InvalidArgumentException;
 
 /**
- * @method static Converter polyphonic()
  * @method static Converter surname()
  * @method static Converter noWords()
  * @method static Converter onlyHans()
@@ -16,6 +15,7 @@
  * @method static Converter useNumberTone()
  * @method static Converter yuToV()
  * @method static Converter yuToU()
+ * @method static Converter polyphonic(bool $asList = false)
  * @method static Converter withToneStyle(string $toneStyle = 'symbol')
  * @method static Collection convert(string $string, callable $beforeSplit = null)
  */
@@ -41,9 +41,14 @@ public static function sentence(string $string, string $toneStyle = Converter::T
         return self::withToneStyle($toneStyle)->convert($string);
     }
 
-    public static function polyphones(string $string, string $toneStyle = Converter::TONE_STYLE_SYMBOL): Collection
+    public static function polyphones(string $string, string $toneStyle = Converter::TONE_STYLE_SYMBOL, bool $asList = false): Collection
     {
-        return self::polyphonic()->withToneStyle($toneStyle)->convert($string);
+        return self::polyphonic($asList)->withToneStyle($toneStyle)->convert($string);
+    }
+
+    public static function polyphonesAsArray(string $string, string $toneStyle = Converter::TONE_STYLE_SYMBOL): Collection
+    {
+        return self::polyphones($string, $toneStyle, true);
     }
 
     public static function chars(string $string, string $toneStyle = Converter::TONE_STYLE_SYMBOL): Collection

diff --git a/tests/ConverterTest.php b/tests/ConverterTest.php
@@ -21,6 +21,12 @@ public function test_polyphonic()
             '重' => ['zhòng', 'chóng', 'tóng'],
             '庆' => ['qìng'],
         ], Converter::make()->polyphonic()->convert('重庆'));
+
+        $this->assertPinyin([
+            ['重' => ['zhòng', 'chóng', 'tóng']],
+            ['庆' => ['qìng']],
+            ['庆' => ['qìng']],
+        ], Converter::make()->polyphonic(true)->convert('重庆庆'));
     }
 
     public function test_surname()

diff --git a/tests/PinyinTest.php b/tests/PinyinTest.php
@@ -125,9 +125,18 @@ public function test_polyphones()
         ], Pinyin::polyphones('重庆', Converter::TONE_STYLE_NONE));
 
         $this->assertPinyin([
-            '重' => ['zhong4', 'chong2', 'tong2'],
-            '庆' => ['qing4'],
-        ], Pinyin::polyphones('重庆', Converter::TONE_STYLE_NUMBER));
+            ['重' => ['zhong4', 'chong2', 'tong2']],
+            ['庆' => ['qing4']],
+            ['重' => ['zhong4', 'chong2', 'tong2']],
+            ['庆' => ['qing4']],
+        ], Pinyin::polyphones('重庆重庆', Converter::TONE_STYLE_NUMBER, true));
+
+        $this->assertPinyin([
+            ['重' => ['zhong4', 'chong2', 'tong2']],
+            ['庆' => ['qing4']],
+            ['重' => ['zhong4', 'chong2', 'tong2']],
+            ['庆' => ['qing4']],
+        ], Pinyin::polyphonesAsArray('重庆重庆', Converter::TONE_STYLE_NUMBER));
     }
 
     public function test_polyphones_chars()
@@ -364,5 +373,28 @@ public function test_issues()
         //119
         $this->assertPinyin(['e', 'e', 'e'], Pinyin::sentence('呃呃呃', 'none'));
         $this->assertPinyin(['wu', 'la', 'gui'], Pinyin::sentence('乌拉圭', 'none'));
+
+        //195
+        $this->assertSame([
+            '你' => ['ni3'],
+            '电' => ['dian4'],
+            '脑' => ['nao3'],
+            '什' => ['shen2', 'shi2'],
+            '么' => ['me', 'yao1', 'mo2', 'ma'],
+            '的' => ['de', 'di1', 'di2', 'di4'],
+        ], Pinyin::polyphones('你电脑电脑电脑什么的', Converter::TONE_STYLE_NUMBER)->toArray());
+
+        $this->assertSame([
+            ['你' => ['ni3']],
+            ['电' => ['dian4']],
+            ['脑' => ['nao3']],
+            ['电' => ['dian4']],
+            ['脑' => ['nao3']],
+            ['电' => ['dian4']],
+            ['脑' => ['nao3']],
+            ['什' => ['shen2', 'shi2']],
+            ['么' => ['me', 'yao1', 'mo2', 'ma']],
+            ['的' => ['de', 'di1', 'di2', 'di4']],
+        ], Pinyin::polyphonesAsArray('你电脑电脑电脑什么的', Converter::TONE_STYLE_NUMBER)->toArray());
     }
 }