LAV45/yii2-translated-behavior

View on GitHub
src/web/LanguageUrlTrait.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php
/**
 * @link https://github.com/LAV45/yii2-translated-behavior
 * @copyright Copyright (c) 2015 LAV45!
 * @author Alexey Loban <lav451@gmail.com>
 * @license http://opensource.org/licenses/BSD-3-Clause
 */

namespace lav45\translate\web;

use Yii;
use lav45\translate\LocaleHelperTrait;

/**
 * Class LanguageUrlTrait
 * @package lav45\translate\web
 *
 * @property string $language
 */
trait LanguageUrlTrait
{
    use LocaleHelperTrait;
    /**
     * @var string
     */
    public $languageParam = '_lang';
    /**
     * @var string set this language if exist in url params. If not set, it will use the value of
     * [[\yii\base\Application::language]].
     */
    private $_language;

    /**
     * @return string
     */
    public function getLanguage()
    {
        if ($this->_language === null) {
            $this->setLanguage(Yii::$app->language);
        }
        return $this->_language;
    }

    /**
     * @param string $locale
     */
    public function setLanguage($locale)
    {
        $this->_language = $this->getPrimaryLanguage($locale);
    }

    /**
     * @param array|string $params
     * @return mixed
     */
    public function checkLanguageParams($params)
    {
        if (is_array($params) && empty($params[$this->languageParam])) {
            $params[$this->languageParam] = $this->getLanguage();
        }
        return $params;
    }
}