eZ\Publish\Core\Repository\Helper\LanguageResolver

Complexity

Total Complexity

11

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setConfigLanguages()	0	4	1
A	setContextLanguage()	0	4	1
A	getPrioritizedLanguages()	0	20	4
A	setUseAlwaysAvailable()	0	4	1
A	getUseAlwaysAvailable()	0	12	3

<?php

namespace eZ\Publish\Core\Repository\Helper;

/**
 * Resolves language settings for use in SiteAccess aware Repository.
 *
 * @todo Take useAlwaysAvailable from setting so it can be configured to false on frontend.
 */
class LanguageResolver
{
    private $configLanguages;
    private $useAlwaysAvailable;
    private $contextLanguage;

    public function __construct(array $configLanguages, $useAlwaysAvailable = null)
    {
        $this->configLanguages = $configLanguages;
        $this->useAlwaysAvailable = $useAlwaysAvailable;
    }

    /**
     * For use by event listening to config resolver scope changes (or other event changing configured languages)
     *
     * @param array $configLanguages
     */
    public function setConfigLanguages(array $configLanguages)
    {
        $this->configLanguages = $configLanguages;
    }

    /**
     * For use by custom events / logic setting language for all retrieved objects from repository.
     *
     * User language will, if set, will have prepended before configured languages. But in cases PHP API consumer
     * specifies languages to retrieve repository objects in it will instead be appended as a fallback.
     *
     * @param string|null $contextLanguage
     */
    public function setContextLanguage($contextLanguage)
    {
        $this->contextLanguage = $contextLanguage;
    }

    /**
     * Get prioritized languages taking into account argument, config and context languages.
     *
     *
     * @param array|null $forcedLanguages Optional, if not empty will be used instead of configured languages, typically
     *        arguments provided to API.
     *
     * @return array
     */
    public function getPrioritizedLanguages(array $forcedLanguages = null)
    {
        $languages = empty($forceLanguages)

The variable $forceLanguages does not exist. Did you mean $forcedLanguages?

            ? $this->configLanguages
            : $forcedLanguages;

        if ($this->contextLanguage === null) {
            return $languages;
        }

        // prepend context language (highest priority) if languages came from config, but append (as fallback)
        // if api user provided languages
        if (empty($forcedLanguages)) {
            array_unshift($languages, $this->contextLanguage);
        } else {
            $languages[] = $this->contextLanguage;
        }

        return $languages;
    }

    /**
     * For use by event listening to config resolver scope changes (or other event changing configured languages).
     *
     * By default this is not set and hence default in API will be used instead.
     *
     * @param bool $useAlwaysAvailable
     */
    public function setUseAlwaysAvailable($useAlwaysAvailable)
    {
        $this->useAlwaysAvailable = $useAlwaysAvailable;
    }

    /**
     * Get currently set UseAlwaysAvailable.
     *
     * @param bool|null $forcedUseAlwaysAvailable Optional, if set will be used instead of configured balue,
     *        typically arguments provided to API.
     * @param bool $defaultUseAlwaysAvailable
     *
     * @return bool
     */
    public function getUseAlwaysAvailable($forcedUseAlwaysAvailable = null, $defaultUseAlwaysAvailable = true)
    {
        if ($forcedUseAlwaysAvailable !== null) {
            return $forcedUseAlwaysAvailable;
        }

        if ($this->useAlwaysAvailable !== null) {
            return $this->useAlwaysAvailable;
        }

        return $defaultUseAlwaysAvailable;
    }
}