Initial re-work using decorator pattern

Signed-off-by: Kevin Hamilton <[email protected]>

src/ConfigProvider.php

@@ -52,10 +52,11 @@ public function getDependencyConfig()
                 Geography\CountryCodeListInterface::class  => Geography\DefaultCountryCodeList::class,
             ],
             'factories' => [
-                Translator\TranslatorInterface::class      => Translator\TranslatorServiceFactory::class,
-                Translator\LoaderPluginManager::class      => Translator\LoaderPluginManagerFactory::class,
-                Translator\PlaceholderPluginManager::class => Translator\PlaceholderPluginManagerFactory::class,
-                Geography\DefaultCountryCodeList::class    => [Geography\DefaultCountryCodeList::class, 'create'],
+                Translator\TranslatorInterface::class          => Translator\TranslatorServiceFactory::class,
+                Translator\LoaderPluginManager::class          => Translator\LoaderPluginManagerFactory::class,
+                Translator\FormatterPluginManager::class       => Translator\FormatterPluginManagerFactory::class,
+                Translator\TranslatorFormatterDecorator::class => Translator\TranslatorFormatterDecoratorFactory::class,
+                Geography\DefaultCountryCodeList::class        => [Geography\DefaultCountryCodeList::class, 'create'],
             ],
         ];
     }

src/Translator/Formatter/FormatterInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\I18n\Translator\Formatter;
+
+interface FormatterInterface
+{
+    /**
+     * @param iterable<array-key, string> $placeholders
+     */
+    public function format(string $locale, string $message, iterable $placeholders = []): string;
+}

src/Translator/Placeholder/HandlebarPlaceholder.php → src/Translator/Formatter/HandlebarFormatter.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Laminas\I18n\Translator\Placeholder;
+namespace Laminas\I18n\Translator\Formatter;
 
 use function str_replace;
 
-class HandlebarPlaceholder implements PlaceholderInterface
+class HandlebarFormatter implements FormatterInterface
 {
-    public function compile(string $locale, string $message, iterable $placeholders = []): string
+    public function format(string $locale, string $message, iterable $placeholders = []): string
     {
         $compiled = $message;
         foreach ($placeholders as $key => $value) {

src/Translator/Placeholder/IcuPlaceholder.php → src/Translator/Formatter/IcuFormatter.php

@@ -2,16 +2,16 @@
 
 declare(strict_types=1);
 
-namespace Laminas\I18n\Translator\Placeholder;
+namespace Laminas\I18n\Translator\Formatter;
 
 use MessageFormatter;
 use Traversable;
 
 use function iterator_to_array;
 
-class IcuPlaceholder implements PlaceholderInterface
+class IcuFormatter implements FormatterInterface
 {
-    public function compile(string $locale, string $message, iterable $placeholders = []): string
+    public function format(string $locale, string $message, iterable $placeholders = []): string
     {
         if ($placeholders instanceof Traversable) {
             $placeholders = iterator_to_array($placeholders);

src/Translator/Placeholder/PrintfPlaceholder.php → src/Translator/Formatter/PrintfFormatter.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace Laminas\I18n\Translator\Placeholder;
+namespace Laminas\I18n\Translator\Formatter;
 
 use Laminas\I18n\Exception\ParseException;
 use Traversable;
 
 use function call_user_func_array;
 use function iterator_to_array;
 
-class PrintfPlaceholder implements PlaceholderInterface
+class PrintfFormatter implements FormatterInterface
 {
-    public function compile(string $locale, string $message, iterable $placeholders = []): string
+    public function format(string $locale, string $message, iterable $placeholders = []): string
     {
         if ($placeholders instanceof Traversable) {
             $placeholders = iterator_to_array($placeholders);

src/Translator/Placeholder/SegmentPlaceholder.php → src/Translator/Formatter/SegmentFormatter.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Laminas\I18n\Translator\Placeholder;
+namespace Laminas\I18n\Translator\Formatter;
 
 use Laminas\I18n\Exception\InvalidArgumentException;
 use Laminas\I18n\Exception\ParseException;
@@ -17,9 +17,9 @@
 use function ucfirst;
 use function uksort;
 
-class SegmentPlaceholder implements PlaceholderInterface
+class SegmentFormatter implements FormatterInterface
 {
-    public function compile(string $locale, string $message, iterable $placeholders = []): string
+    public function format(string $locale, string $message, iterable $placeholders = []): string
     {
         if ($placeholders instanceof Traversable) {
             $placeholders = iterator_to_array($placeholders);

src/Translator/PlaceholderPluginManager.php → src/Translator/FormatterPluginManager.php

@@ -19,31 +19,31 @@
  * Placeholder\PlaceholderInterface. Additionally, it registers a number
  * of default placeholder compilers.
  *
- * @template InstanceType of Placeholder\PlaceholderInterface
+ * @template InstanceType of Formatter\FormatterInterface
  * @extends AbstractPluginManager<InstanceType>
- * @method Placeholder\PlaceholderInterface get(string $name, ?array $options = null)
+ * @method Formatter\FormatterInterface get(string $name, ?array $options = null)
  */
-class PlaceholderPluginManager extends AbstractPluginManager
+class FormatterPluginManager extends AbstractPluginManager
 {
     /** @inheritDoc */
     protected $aliases = [
-        'segment'    => Placeholder\SegmentPlaceholder::class,
-        'colon'      => Placeholder\SegmentPlaceholder::class,
-        'laravel'    => Placeholder\SegmentPlaceholder::class,
-        'handlebar'  => Placeholder\HandlebarPlaceholder::class,
-        'handlebars' => Placeholder\HandlebarPlaceholder::class,
-        'icu'        => Placeholder\IcuPlaceholder::class,
-        'vsprintf'   => Placeholder\PrintfPlaceholder::class,
-        'sprintf'    => Placeholder\PrintfPlaceholder::class,
-        'printf'     => Placeholder\PrintfPlaceholder::class,
+        'segment'    => Formatter\SegmentFormatter::class,
+        'colon'      => Formatter\SegmentFormatter::class,
+        'laravel'    => Formatter\SegmentFormatter::class,
+        'handlebar'  => Formatter\HandlebarFormatter::class,
+        'handlebars' => Formatter\HandlebarFormatter::class,
+        'icu'        => Formatter\IcuFormatter::class,
+        'vsprintf'   => Formatter\PrintfFormatter::class,
+        'sprintf'    => Formatter\PrintfFormatter::class,
+        'printf'     => Formatter\PrintfFormatter::class,
     ];
 
     /** @inheritDoc */
     protected $factories = [
-        Placeholder\SegmentPlaceholder::class   => InvokableFactory::class,
-        Placeholder\HandlebarPlaceholder::class => InvokableFactory::class,
-        Placeholder\IcuPlaceholder::class       => InvokableFactory::class,
-        Placeholder\PrintfPlaceholder::class    => InvokableFactory::class,
+        Formatter\SegmentFormatter::class   => InvokableFactory::class,
+        Formatter\HandlebarFormatter::class => InvokableFactory::class,
+        Formatter\IcuFormatter::class       => InvokableFactory::class,
+        Formatter\PrintfFormatter::class    => InvokableFactory::class,
     ];
 
     /**
@@ -57,15 +57,15 @@ class PlaceholderPluginManager extends AbstractPluginManager
      */
     public function validate(mixed $instance): void
     {
-        if ($instance instanceof Placeholder\PlaceholderInterface) {
+        if ($instance instanceof Formatter\FormatterInterface) {
             // we're okay
             return;
         }
 
         throw new InvalidServiceException(sprintf(
             'Plugin of type %s is invalid; must implement %s',
             is_object($instance) ? $instance::class : gettype($instance),
-            Placeholder\PlaceholderInterface::class
+            Formatter\FormatterInterface::class
         ));
     }
 }

src/Translator/PlaceholderPluginManagerFactory.php → src/Translator/FormatterPluginManagerFactory.php

@@ -12,25 +12,22 @@
 use function is_array;
 
 /** @psalm-import-type ServiceManagerConfiguration from ServiceManager */
-class PlaceholderPluginManagerFactory implements FactoryInterface
+final class FormatterPluginManagerFactory implements FactoryInterface
 {
     /**
-     * Create and return a PlaceholderPluginManager.
-     *
      * @param string $requestedName
      * @param array<array-key, mixed>|null $options
      * @throws ContainerExceptionInterface
      * @throws NotFoundExceptionInterface
-     * @psalm-suppress ArgumentTypeCoercion
      * @psalm-suppress DeprecatedClass
      */
     public function __invoke(
         ContainerInterface $container,
         $requestedName,
         ?array $options = null
-    ): PlaceholderPluginManager {
+    ): FormatterPluginManager {
         $options     ??= [];
-        $pluginManager = new PlaceholderPluginManager($container, $options);
+        $pluginManager = new FormatterPluginManager($container, $options);
 
         // If this is in a laminas-mvc application, the ServiceListener will inject
         // merged configuration during bootstrap.
@@ -46,12 +43,12 @@ public function __invoke(
         $config = $container->get('config');
 
         // If we do not have translator_plugins configuration, nothing more to do
-        if (! isset($config['translator_placeholders']) || ! is_array($config['translator_placeholders'])) {
+        if (! isset($config['translator_formatter']) || ! is_array($config['translator_formatter'])) {
             return $pluginManager;
         }
 
         // Wire service configuration for translator_plugins
-        (new Config($config['translator_placeholders']))->configureServiceManager($pluginManager);
+        (new Config($config['translator_formatter']))->configureServiceManager($pluginManager);
 
         return $pluginManager;
     }

src/Translator/Translator.php

@@ -11,14 +11,12 @@
 use Laminas\I18n\Exception;
 use Laminas\I18n\Translator\Loader\FileLoaderInterface;
 use Laminas\I18n\Translator\Loader\RemoteLoaderInterface;
-use Laminas\I18n\Translator\Placeholder\PlaceholderInterface;
 use Laminas\ServiceManager\ServiceManager;
 use Laminas\Stdlib\ArrayUtils;
 use Locale;
 use Traversable;
 
 use function array_shift;
-use function ctype_digit;
 use function get_debug_type;
 use function is_array;
 use function is_file;
@@ -30,7 +28,7 @@
 /**
  * Translator.
  */
-class Translator implements TranslatorInterface, TranslatorWithParamsInterface
+class Translator implements TranslatorInterface
 {
     /**
      * Event fired when the translation for a message is missing.
@@ -112,8 +110,6 @@ class Translator implements TranslatorInterface, TranslatorWithParamsInterface
      */
     protected $eventsEnabled = false;
 
-    protected ?PlaceholderInterface $placeholder = null;
-
     /**
      * Instantiate a translator
      *
@@ -419,49 +415,6 @@ public function translatePlural(
         return $index === 0 ? $singular : $plural;
     }
 
-    /**
-     * @param iterable<string|int, string> $params
-     */
-    public function translateWithParams(
-        string $message,
-        iterable $params = [],
-        string $textDomain = 'default',
-        ?string $locale = null
-    ): string {
-        $locale ??= $this->getLocale();
-
-        return $this->compileMessage($this->translate($message, $textDomain, $locale), $params, $locale);
-    }
-
-    /**
-     * The first number in params is used to determine the plural form.
-     *
-     * @param iterable<string|int, string> $params
-     */
-    public function translatePluralWithParams(
-        string $singular,
-        string $plural,
-        iterable $params = [],
-        string $textDomain = 'default',
-        ?string $locale = null
-    ): string {
-        $locale ??= $this->getLocale();
-
-        $number = 1;
-        foreach ($params as $param) {
-            if (ctype_digit($param)) {
-                $number = (int) $param;
-                break;
-            }
-        }
-
-        return $this->compileMessage(
-            $this->translatePlural($singular, $plural, $number, $textDomain, $locale),
-            $params,
-            $locale
-        );
-    }
-
     /**
      * Get a translated message.
      *
@@ -866,11 +819,6 @@ public function disableEventManager()
         return $this;
     }
 
-    public function setPlaceholder(PlaceholderInterface $placeholder): void
-    {
-        $this->placeholder = $placeholder;
-    }
-
     protected function storeTextDomain(string $textDomain, string $locale, ?TextDomain $loaded): void
     {
         if (! $loaded instanceof TextDomain) {
@@ -883,18 +831,4 @@ protected function storeTextDomain(string $textDomain, string $locale, ?TextDoma
             $this->messages[$textDomain][$locale] = $loaded;
         }
     }
-
-    /**
-     * @param iterable<string|int, string> $placeholders
-     */
-    protected function compileMessage(?string $message, iterable $placeholders, string $locale): string
-    {
-        return $this->placeholder && $message !== '' && $message !== null ?
-            $this->placeholder->compile(
-                $locale,
-                $message,
-                $placeholders
-            ) :
-            ($message ?? '');
-    }
 }