yiimaker/yii2-data-static

Yii2 Static Data

1.2.2 2017-01-10 15:03 UTC

Requires

• yiimaker/yii2-configuration: ^1.3.0
• yiisoft/yii2: *

BSD-3-Clause

• Ruslan Saiko

• extension
• yii2
• static data

README

It is a model for the data that stores configuration. StaticData subject to the same rules as yii\base\Model

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiimaker/yii2-data-static "*"

or add

"yiimaker/yii2-data-static": "*"

to the require section of your composer.json file.

Usage

1. Configure component yiimaker/yii2-configuration in config file or in StaticData class. More information
2. Inherit the class ymaker\data\statics\StaticData, then describe it as a normal model.

Example

StaticData

class AboutUs extends ymaker\data\statics\StaticData
{
    public $phone;
    public $email;

    public function rules()
    {
        return [
            [['phone', 'email'], 'required'],
            ['phone', 'string', 'max' => 255],
            ['email', 'email']
        ];
    }
}

$aboutUs = new AboutUs();

Save Data

$aboutUs->phone = '[phone]';
$aboutUs->email = '[e-mail]';
$aboutUs->save();

Load Data

$aboutUs->loadAttributes();
echo $aboutUs->email; // '[e-mail]';

or

$aboutUs = AboutUs::getInstance();

Reload Data

$aboutUs->loadAttributes();
$aboutUs->email = '[e-mail]';
$aboutUs->reload();

echo $aboutUs->email; // '[e-mail]';

StaticDataTranslation

class AboutUs extends ymaker\data\statics\StaticDataTranslation
{
    public $address;

    public function rules()
    {
        return [
            [['address'], 'required'],
            ['address', 'string', 'max' => 255],
        ];
    }
}

$aboutUs = new AboutUs(['language' => 'en-US']);
// $about

Save Data

$aboutUs->address = 'Kiev, Ukraine';
$aboutUs->save();
$aboutUs->setLanguage('ru-RU');
$aboutUs->address = 'Киев, Украина';
$aboutUs->save();

Load Data

$aboutUs->loadAttributes();
echo $aboutUs->address; // 'Киев, Украина'
$aboutUs->changeLanguage('en-US');
echo $aboutUs->address; // 'Kiev, Ukraine'

or

$aboutUs = AboutUs::getInstance(['language' => 'en-US']);

Reload Data

$aboutUs->loadAttributes();
$aboutUs->address = 'Лондон, Великобритания';
$aboutUs->reload();

echo $aboutUs->address; // 'Киев, Украина'

change language

    /**
     * change language for model
     * @param $language string language code
     * @param bool $reload If true, then all attributes will be overwritten
     */
    public function changeLanguage($language, $reload = true);

echo $aboutUs->address; // 'Киев, Украина'
$aboutUs->changeLanguage('en-US');
echo $aboutUs->address; // 'Kiev, Ukraine'

$aboutUs->changeLanguage('ru-RU', false);
echo $aboutUs->address; // 'Kiev, Ukraine'

$aboutUs->reload();
echo $aboutUs->address; // 'Киев, Украина'