Limoncello\Application\Packages\L10n\L10nSettings

Complexity

Total Complexity

8

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getSettings()	0	6	1
A	get()	0	21	2
A	getAppConfig()	0	4	1
A	getMessageDescriptionsFromProviders()	0	12	4

<?php namespace Limoncello\Application\Packages\L10n;

/**
 * Copyright 2015-2017 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Limoncello\Contracts\Application\ApplicationConfigurationInterface as A;
use Limoncello\Contracts\Provider\ProvidesMessageResourcesInterface;
use Limoncello\Contracts\Settings\SettingsInterface;
use Limoncello\l10n\Messages\FileBundleEncoder;

/**
 * @package Limoncello\Application
 */
abstract class L10nSettings implements SettingsInterface
{
    /** Settings key */
    const KEY_DEFAULT_LOCALE = 0;

    /** Settings key */
    const KEY_LOCALES_FOLDER = self::KEY_DEFAULT_LOCALE + 1;

    /** Settings key */
    const KEY_LOCALES_DATA = self::KEY_LOCALES_FOLDER + 1;

    /** Settings key */
    protected const KEY_LAST = self::KEY_LOCALES_DATA;

    /**
     * @var array
     */
    private $appConfig;

    /**
     * @inheritdoc
     */
    final public function get(array $appConfig): array
    {
        $this->appConfig = $appConfig;

        $defaults = $this->getSettings();

        $defaultLocale = $defaults[static::KEY_DEFAULT_LOCALE] ?? null;
        assert(empty($defaultLocale) === false, "Invalid default locale `$defaultLocale`.");

        $localesFolder = $defaults[static::KEY_LOCALES_FOLDER] ?? null;
        assert(
            $localesFolder !== null && empty(glob($localesFolder)) === false,
            "Invalid Locales folder `$localesFolder`."
        );

        $bundleEncoder = new FileBundleEncoder($this->getMessageDescriptionsFromProviders(), $localesFolder);

$this->getMessageDescriptionsFromProviders() is of type object<Generator>, but the function expects a object<Limoncello\l10n\Messages\iterable>|null.

        return $defaults + [
                static::KEY_LOCALES_DATA => $bundleEncoder->getStorageData($defaultLocale),
            ];
    }

    /**
     * @return array
     */
    protected function getSettings(): array
    {
        return [
            static::KEY_DEFAULT_LOCALE => 'en',
        ];
    }

    /**
     * @return mixed
     */
    protected function getAppConfig()
    {
        return $this->appConfig;
    }

    /**
     *
     * @return iterable

Should the return type not be \Generator?

     */
    private function getMessageDescriptionsFromProviders(): iterable
    {
        $providerClasses = $this->getAppConfig()[A::KEY_PROVIDER_CLASSES] ?? [];
        foreach ($providerClasses as $class) {
            if (in_array(ProvidesMessageResourcesInterface::class, class_implements($class)) === true) {
                /** @var ProvidesMessageResourcesInterface $class */
                foreach ($class::getMessageDescriptions() as $messageDescription) {
                    yield $messageDescription;
                }
            }
        }
    }
}