I18nResponseFormatBuilder::formatTranslatableViolationList()

Complexity

Conditions	13
Paths	9

Size

Total Lines	114
Code Lines	60

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	2

<?php
    public function formatTranslatableViolationList(
        ConstraintViolationListInterface $violations,
        $sortProperties = true,
        $useAllLanguages = true,
        array $targetLocales = [],
        $domain = 'messages'
    ) {
        $hasLocales = count($targetLocales) > 0;

        if (!$useAllLanguages && $hasLocales) {
            throw new \InvalidArgumentException(
                'Wrong usage of $targetLocales: If the default locale is the only target, $targetLocales must not have any values!'
            );
        }

        if ($useAllLanguages && !$hasLocales) {
            throw new \InvalidArgumentException(
                'Wrong usage of $targetLocales: If the all locales should be rendered, $targetLocales must be given!'
            );
        }

        $fixtures = [];
        foreach ($violations as $violation) {
            // Every translation entry (whether sorted by properties in deeper levels or as top level)
            // should provide a basic structure.
            switch (true) {
                // If sorted by $targetLanguages, it may look like this:
                //
                // [
                //   'de' => ['Deutscher Text'],
                //   'en' => ['English text'],
                // ]
                //
                // When sorting by property, the structure will be merged recursively into the property list:
                //
                // [
                //   'property' => [
                //     // this is the structure merged into the property.
                //     'de' => ['Deutscher Text'],
                //     'en' => ['English text'],
                //   ]
                // ]
                case $useAllLanguages:
                    $structure = array_reduce(
                        $targetLocales,
                        function ($carry, $locale) use ($violation, $domain) {
                            if (!isset($carry[$locale])) {
                                $carry[$locale] = [];
                            }

                            if ($locale === $this->translator->getLocale()) {
                                $carry[$locale][] = $violation->getMessage();
                            } else {
                                $messageTemplate = $violation->getMessageTemplate();
                                $parameters      = $violation->getParameters();

                                if ($plural = $violation->getPlural()) {
                                    try {
                                        $message = $this->translator->transChoice(
                                            $messageTemplate,
                                            $plural,
                                            $parameters,
                                            $domain,
                                            $locale
                                        );
                                    } catch (\InvalidArgumentException $ex) {
                                        // we do nothing here.
                                        // If the pluralization fails, the default translation method will be used.

                                        $message = $this->translator->trans(
                                            $messageTemplate,
                                            $parameters,
                                            $domain,
                                            $locale
                                        );
                                    }
                                } else {
                                    $message = $this->translator->trans(
                                        $messageTemplate,
                                        $parameters,
                                        $domain,
                                        $locale
                                    );
                                }

                                $carry[$locale][] = $message;
                            }

                            return $carry;
                        },
                        []
                    );
                    break;
                default:
                    // If the default language is in use and nothing more, the structure looks like this:
                    //
                    // ['Message in the currently selected language']
                    $structure = [$violation->getMessage()];
            }

            if (!$sortProperties) {
                $fixtures = array_merge_recursive($fixtures, $structure);
            } else {
                $propertyPath = $violation->getPropertyPath();
                if (!isset($fixtures[$violation->getPropertyPath()])) {
                    $fixtures[$violation->getPropertyPath()] = [];
                }

                $fixtures[$propertyPath] = array_merge_recursive($fixtures[$propertyPath], $structure);
            }
        }

        return $fixtures;
    }
}