Add ThemeColor

Author: 0b10011

CHANGELOG.md

@@ -12,7 +12,7 @@ This release marked the addition of return type declarations (PHP 7+).
 - Set complex type in template @troosan #1565
 - Add support for page vertical alignment. @troosan #672 #1569
 - Length validation with `PhpOffice\PhpWord\Style\Lengths\{Absolute, Auto, Percent}` @0b10011 #1669
-- Color validation with `PhpOffice\PhpWord\Style\Colors\{HighlightColor, Hex, Rgb, SystemColor}` @0b10011 #1669
+- Color validation with `PhpOffice\PhpWord\Style\Colors\{HighlightColor, Hex, Rgb, SystemColor, ThemeColor}` @0b10011 #1669
 - BorderStyle validation with `PhpOffice\PhpWord\Style\BorderStyle` @0b10011 #1669
 
 ### Fixed

src/PhpWord/Style/Colors/Color.php

@@ -21,10 +21,8 @@ public static function fromMixed($value = null): AbstractColor
         } elseif (is_string($value)) {
             if (Hex::isValid($value)) {
                 return new Hex($value);
-            } elseif (SystemColor::isValid($value)) {
-                return new SystemColor($value);
-            } elseif (HighlightColor::isValid($value)) {
-                return new HighlightColor($value);
+            } elseif (ThemeColor::isValid($value)) {
+                return new ThemeColor($value);
             }
         }
 

src/PhpWord/Style/Colors/ThemeColor.php

@@ -0,0 +1,50 @@
+<?php
+declare(strict_types=1);
+
+namespace PhpOffice\PhpWord\Style\Colors;
+
+use PhpOffice\PhpWord\Exception\Exception;
+
+final class ThemeColor extends AbstractColor implements NamedColorInterface
+{
+    /**
+     * Taken from https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.drawing.colorscheme?view=openxml-2.8.1
+     * @todo Check if 'extLst' (Extension List) can add additional colors to this list.
+     * @var array
+     */
+    private static $allowedColors = array(
+        'dk1'      => true,
+        'lt1'      => true,
+        'dk2'      => true,
+        'lt2'      => true,
+        'accent1'  => true,
+        'accent2'  => true,
+        'accent3'  => true,
+        'accent4'  => true,
+        'accent5'  => true,
+        'accent6'  => true,
+        'hlink'    => true,
+        'folHlink' => true,
+    );
+
+    private $name;
+
+    public function __construct(string $name)
+    {
+        if (!static::isValid($name)) {
+            throw new Exception(sprintf("Provided color must be a valid theme color. '%s' provided. Allowed: %s", $name, implode(', ', array_keys(self::$allowedColors))));
+        }
+
+        $this->name = $name;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public static function isValid(string $color): bool
+    {
+        return array_key_exists($color, self::$allowedColors);
+    }
+}

tests/PhpWord/Style/Colors/ColorTest.php

@@ -27,8 +27,7 @@ public function testConversions()
     {
         // Prepare test values [ original, expected ]
         $values = array(
-            array('yellow', HighlightColor::class, 'yellow'),
-            array('window', SystemColor::class, 'window'),
+            array('lt1', ThemeColor::class, 'lt1'),
             array('a0b', Hex::class, 'AA00BB'),
             array('aB01cD', Hex::class, 'AB01CD'),
             array('', AbstractColor::class, null),