feat(font): add default asian font name (#2714)

* feat(font): add default asian font name * doc: examples and changes * test: add test for DefaultAsianFontName * fix: specify the return value type Co-authored-by: Progi1984 <[email protected]> * test: test set/get function in PHPWord * style: removed unused annotiation --------- Co-authored-by: Jui-Nan Lin <[email protected]> Co-authored-by: Progi1984 <[email protected]>
PHPOffice · Jan 15, 2025 · 337dc27 · 337dc27
1 parent f9da10e
commit 337dc27
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 2 deletions.
diff --git a/docs/changes/1.x/1.4.0.md b/docs/changes/1.x/1.4.0.md
@@ -4,6 +4,8 @@
 
 ## Enhancements
 
+- Default Font: Allow specify Asisn font and Latin font separately
+
 - Writer ODText: Support for ListItemRun by [@Progi1984](https://github.com/Progi1984) fixing [#2159](https://github.com/PHPOffice/PHPWord/issues/2159), [#2620](https://github.com/PHPOffice/PHPWord/issues/2620) in [#2669](https://github.com/PHPOffice/PHPWord/pull/2669)
 - Writer HTML: Support for vAlign in Tables by [@SpraxDev](https://github.com/SpraxDev) in [#2675](https://github.com/PHPOffice/PHPWord/pull/2675)
 - Added support for PHP 8.4 by [@Progi1984](https://github.com/Progi1984) in [#2660](https://github.com/PHPOffice/PHPWord/pull/2660)

diff --git a/docs/usage/introduction.md b/docs/usage/introduction.md
@@ -137,6 +137,14 @@ $phpWord->setDefaultFontName('Times New Roman');
 $phpWord->setDefaultFontSize(12);
 ```
 
+Or you can specify Asian Font
+
+``` php
+<?php
+
+$phpWord->setDefaultAsianFontName('標楷體');
+```
+
 ## Document settings
 
 Settings for the generated document can be set using ``$phpWord->getSettings()``
@@ -380,4 +388,4 @@ To control whether or not words in all capital letters shall be hyphenated use t
 <?php
 
 $phpWord->getSettings()->setDoNotHyphenateCaps(true);
-```
+```
diff --git a/src/PhpWord/PhpWord.php b/src/PhpWord/PhpWord.php
@@ -257,6 +257,24 @@ public function setDefaultFontName($fontName): void
         Settings::setDefaultFontName($fontName);
     }
 
+    /**
+     * Get default asian font name.
+     */
+    public function getDefaultAsianFontName(): string
+    {
+        return Settings::getDefaultAsianFontName();
+    }
+
+    /**
+     * Set default font name.
+     *
+     * @param string $fontName
+     */
+    public function setDefaultAsianFontName($fontName): void
+    {
+        Settings::setDefaultAsianFontName($fontName);
+    }
+
     /**
      * Get default font size.
      *

diff --git a/src/PhpWord/Settings.php b/src/PhpWord/Settings.php
@@ -118,6 +118,13 @@ class Settings
      */
     private static $defaultFontName = self::DEFAULT_FONT_NAME;
 
+    /**
+     * Default font name.
+     *
+     * @var string
+     */
+    private static $defaultAsianFontName = self::DEFAULT_FONT_NAME;
+
     /**
      * Default font size.
      *
@@ -355,6 +362,14 @@ public static function getDefaultFontName(): string
         return self::$defaultFontName;
     }
 
+    /**
+     * Get default font name.
+     */
+    public static function getDefaultAsianFontName(): string
+    {
+        return self::$defaultAsianFontName;
+    }
+
     /**
      * Set default font name.
      */
@@ -369,6 +384,17 @@ public static function setDefaultFontName(string $value): bool
         return false;
     }
 
+    public static function setDefaultAsianFontName(string $value): bool
+    {
+        if (trim($value) !== '') {
+            self::$defaultAsianFontName = $value;
+
+            return true;
+        }
+
+        return false;
+    }
+
     /**
      * Get default font size.
      *

diff --git a/src/PhpWord/Writer/Word2007/Part/Styles.php b/src/PhpWord/Writer/Word2007/Part/Styles.php
@@ -84,6 +84,7 @@ private function writeDefaultStyles(XMLWriter $xmlWriter, $styles): void
     {
         $phpWord = $this->getParentWriter()->getPhpWord();
         $fontName = $phpWord->getDefaultFontName();
+        $asianFontName = $phpWord->getDefaultAsianFontName();
         $fontSize = $phpWord->getDefaultFontSize();
         $language = $phpWord->getSettings()->getThemeFontLang();
         $latinLanguage = ($language == null || $language->getLatin() === null) ? 'en-US' : $language->getLatin();
@@ -95,7 +96,7 @@ private function writeDefaultStyles(XMLWriter $xmlWriter, $styles): void
         $xmlWriter->startElement('w:rFonts');
         $xmlWriter->writeAttribute('w:ascii', $fontName);
         $xmlWriter->writeAttribute('w:hAnsi', $fontName);
-        $xmlWriter->writeAttribute('w:eastAsia', $fontName);
+        $xmlWriter->writeAttribute('w:eastAsia', $asianFontName);
         $xmlWriter->writeAttribute('w:cs', $fontName);
         $xmlWriter->endElement(); // w:rFonts
         $xmlWriter->startElement('w:sz');

diff --git a/tests/PhpWordTests/PhpWordTest.php b/tests/PhpWordTests/PhpWordTest.php
@@ -83,6 +83,18 @@ public function testSetGetDefaultFontSize(): void
         self::assertEquals($fontSize, $phpWord->getDefaultFontSize());
     }
 
+    /**
+     * Test set/get default asian font name.
+     */
+    public function testSetGetDefaultAsianFontName(): void
+    {
+        $phpWord = new PhpWord();
+        $fontName = 'Times New Roman';
+        self::assertEquals(Settings::DEFAULT_FONT_NAME, $phpWord->getDefaultAsianFontName());
+        $phpWord->setDefaultAsianFontName($fontName);
+        self::assertEquals($fontName, $phpWord->getDefaultAsianFontName());
+    }
+
     /**
      * Test set default paragraph style.
      */

diff --git a/tests/PhpWordTests/SettingsTest.php b/tests/PhpWordTests/SettingsTest.php
@@ -217,6 +217,20 @@ public function testSetGetDefaultFontName(): void
         self::assertEquals('Times New Roman', Settings::getDefaultFontName());
     }
 
+    /**
+     * Test set/get default font name.
+     */
+    public function testSetGetDefaultAsianFontName(): void
+    {
+        self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultAsianFontName());
+        self::assertFalse(Settings::setDefaultAsianFontName(' '));
+        self::assertEquals(Settings::DEFAULT_FONT_NAME, Settings::getDefaultAsianFontName());
+        self::assertTrue(Settings::setDefaultAsianFontName('Times New Roman'));
+        self::assertEquals('Times New Roman', Settings::getDefaultAsianFontName());
+        self::assertFalse(Settings::setDefaultAsianFontName(' '));
+        self::assertEquals('Times New Roman', Settings::getDefaultAsianFontName());
+    }
+
     /**
      * Test set/get default font size.
      */