andmemasin / language

src/models/LanguageSettingsPack.php

<?php

namespace andmemasin\language\models;


use andmemasin\language\interfaces\WithLanguagesInterface;
use yii\base\Model;
use yii;

/**
 * Class LanguageSettingsPack is a pack of BaseLanguageSettings each in different language
 *
 * @property Language $language
 * @package andmemasin\language\models
 */
class LanguageSettingsPack extends Model
{
    /** @var string */
    public $languageSettingsClass;

    /** @var BaseLanguageSettings[] Settings for one language. array is indexed by language_id */
    public $languageSettings;

    /** @var WithLanguagesInterface */
    public $parent;


    /** {@inheritdoc} */
    public function init()
    {
        parent::init();

        if(!$this->parent){
            throw new yii\base\InvalidConfigException('Parent Model must be defined while initiating languages-settings');
        }

        if(!$this->parent instanceof WithLanguagesInterface){

$this->parent is always a sub-type of andmemasin\language\interfaces\WithLanguagesInterface.

            throw new yii\base\InvalidConfigException('Parent Model must implement WithLanguagesInterface');
        }
        $this->setLanguageSettings();

    }

    protected function setLanguageSettings() {
        if(!empty($this->parent->languages)){
            foreach ($this->parent->languages as $language){
                /* @var BaseLanguageSettings $languageSettings */
                $languageSettings = Yii::createObject([
                    'class' => $this->languageSettingsClass,
                    'parent'=>$this->parent,
                    'language'=>$language,
                ]);
                $this->languageSettings[$language->language_id] = $languageSettings;
            }
        }
    }

    public function save($runValidation = true,$attributeNames=null){
        if(!empty($this->languageSettings)){
            // language by language
            foreach ($this->languageSettings as $key => $languageSetting){
                $languageSetting->save($runValidation,$attributeNames);
                $this->addErrors($languageSetting->errors);
                $this->languageSettings[$key] = $languageSetting;
            }
        }
        $this->setLanguageSettings();

        return empty($this->errors);
    }

    /**
     *
     * @param Language $language
     * @param string $key
     * @return bool|string
     */
    public function getSettingByLanguageAndKey($language, $key){
        $setting = $this->getSettingByKeyAndLanguage($language, $key);
        if(!$setting){
            $setting = $this->getSettingByKeyInAnyLanguage($key);
        }
        return $setting;
    }

    /**
     * Get the setting value in specified language by key.
     * Returns false if setting is missing or empty
     * @param Language $language
     * @param string $key
     * @return bool|string
     */
    public function getSettingByKeyAndLanguage($language, $key){
        if(isset($this->languageSettings[$language->primaryKey])){
            $languageSettings = $this->languageSettings[$language->primaryKey];
            if($languageSettings->{$key} && $languageSettings->{$key} != ''){
                return $languageSettings->{$key};
            }
        }
        return false;
    }


    /**
     * Get the setting value in any language
     * Returns false if setting is missing or empty in all languages
     * @param string $key
     * @return bool|string
     */
    public function getSettingByKeyInAnyLanguage($key){
        if(!empty($this->languageSettings)){
            foreach ($this->languageSettings as $language_id => $languageSettings){
                if($languageSettings->{$key} && $languageSettings->{$key} != ''){
                    return $languageSettings->{$key};
                }
            }
        }
        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function load($data, $formName = null)
    {
        $scope = yii\helpers\StringHelper::basename($this->languageSettingsClass);
        if (isset($data[$scope])) {
            foreach ($data[$scope] as $language_id => $attributes){
                $language = Language::findOne((int) $language_id);
                /** @var BaseLanguageSettings $model */
                if(isset($this->languageSettings[$language_id])){
                    $model = $this->languageSettings[$language_id];
                } else {
                    $model = Yii::createObject([
                        'class' => $this->languageSettingsClass,
                        'parent'=>$this->parent,
                        'language'=>$language,
                    ]);
                }
                $model->settingsData = $attributes;
                $model->setSettings();
                $model->validate();

                // load this language
                $this->addErrors($model->errors);
            }
            return true;
        }
        return false;
    }

}