Yiisoft\TranslatorExtractor\CategorySource

Complexity

Total Complexity

5

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	writeMessages()	0	3	1
A	getName()	0	3	1
A	readMessages()	0	3	1
A	__construct()	0	8	2

<?php

declare(strict_types=1);

namespace Yiisoft\TranslatorExtractor;

use RuntimeException;
use Yiisoft\Translator\MessageReaderInterface;
use Yiisoft\Translator\MessageWriterInterface;

/**
 * Represents message category for reading and writing messages.
 */
final class CategorySource
{
    /**
     * @param string $name Category name.
     */
    public function __construct(
        private string $name,
        private MessageReaderInterface $reader,
        private MessageWriterInterface $writer
    ) {
        if (!preg_match('/^[a-z0-9_-]+$/i', $name)) {
            throw new RuntimeException(
                'Category name is invalid. Only letters, numbers, dash, and underscore are allowed.'
            );
        }
    }

    /**
     * @return string Category name.
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @param string $category Category of messages to get.
     * @param string $locale Locale of messages to get.
     *
     * @psalm-return array<string, array<string, string>>
     *
     * @return array All messages from category. The format is
     * the same as in {@see \Yiisoft\Translator\MessageReaderInterface::getMessages()}.
     */
    public function readMessages(string $category, string $locale): array
    {
        return $this->reader->getMessages($category, $locale);
    }

    /**
     * @param string $category Category to write messages to.
     * @param string $locale Locale to write messages for.
     * @param array $messages Messages to write.
     *
     * @psalm-param array<string, array<string, string>> $messages
     *
     * @see \Yiisoft\Translator\MessageWriterInterface::write
     */
    public function writeMessages(string $category, string $locale, array $messages): void
    {
        $this->writer->write($category, $locale, $messages);
    }
}