YahooJapan\ConfigCacheBundle\ConfigCache\Locale\ConfigCache

Complexity

Total Complexity

17

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setReferableLocales()	0	6	1
A	setDefaultLocale()	0	6	1
A	setCurrentLocale()	0	6	1
A	create()	0	17	4
A	save()	0	6	2
A	restore()	0	6	2
A	createInternal()	0	7	1
A	findId()	0	14	3
A	getLocale()	0	4	2

<?php

/*
 * This file is part of the ConfigCacheBundle package.
 *
 * Copyright (c) 2015-2016 Yahoo Japan Corporation
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace YahooJapan\ConfigCacheBundle\ConfigCache\Locale;

use YahooJapan\ConfigCacheBundle\ConfigCache\ConfigCache as BaseConfigCache;
use YahooJapan\ConfigCacheBundle\ConfigCache\Locale\Loader\TranslationLoaderInterface;

/**
 * ConfigCache manages user configuration files with locale.
 */
class ConfigCache extends BaseConfigCache implements ConfigCacheInterface
{
    const TAG_LOCALE = 'config_cache.locale';

    // for createing cache
    protected $referableLocales = array();
    // for getting cache
    protected $defaultLocale;
    protected $currentLocale;

    /**
     * {@inheritdoc}
     */
    public function setReferableLocales(array $locales)
    {
        $this->referableLocales = $locales;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setDefaultLocale($locale)
    {
        $this->defaultLocale = $locale;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function setCurrentLocale($currentLocale)
    {
        $this->currentLocale = $currentLocale;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function create()
    {
        if (!($this->loader instanceof TranslationLoaderInterface)) {
            throw new \Exception(sprintf(
                '%s: Loader [%s] must be a translation loader interface',
                __CLASS__,
                get_class($this->loader)
            ));
        }

        foreach ($this->referableLocales as $locale) {
            if (!$this->cache->contains($this->findId($locale))) {
                $this->loader->setLocale($locale);
                $this->createInternal($locale);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function save()
    {
        foreach ($this->referableLocales as $locale) {
            $this->findRestorableCache()->saveToTemp($this->findId($locale));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function restore()
    {
        foreach ($this->referableLocales as $locale) {
            $this->findRestorableCache()->restore($this->findId($locale));
        }
    }

    /**
     * Creates PHP cache file internal processing.
     *
     * this method has a $locale argument for executing findAll() but no cache.
     *
     * @param string $locale
     *
     * @return array
     */
    protected function createInternal($locale = null)
    {
        $data = $this->load();
        $this->cache->save($this->findId($locale), $data);

        return $data;
    }

    /**
     * Finds a doctrine cache ID with locale.
     *
     * $locale argument has the potential to become null when findAll().
     *
     * @param string $locale
     *
     * @return string
     */
    protected function findId($locale = null)
    {
        if (is_null($locale)) {
            $locale = $this->getLocale();

            // no chance of this block
            // because of having getLocale() return value (always configured on setDefaultLocale()).
            if (is_null($locale)) {
                throw new \Exception('Locale must be set.');
            }
        }

        return parent::findId().".{$locale}";
    }

    /**
     * Gets a locale.
     *
     * @return string
     */
    protected function getLocale()
    {
        return $this->currentLocale ?: $this->defaultLocale;
    }
}