README

Improved PostgreSQL schemas for Yii2.

Supports follow types for ActiveRecord models:

Limitation

When you use this extension you can't specify the PDO type by using an array: [value, type],

e.g. ['name' => 'John', 'profile' => [$profile, \PDO::PARAM_LOB]].

See the issue #7481

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist i-excellent/yii2-pgsql-schema

or add

"i-excellent/yii2-pgsql-schema": "~1.0"

to the require section of your composer.json file.

Configuration

Once the extension is installed, add following code to your application configuration:

return [
    //...
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'pgsql:host=localhost;dbname=<database>',
            'username' => 'postgres',
            'password' => '<password>',
            'schemaMap' => [
                'pgsql'=> 'excellent\pgsql\Schema',
            ],
        ],
    ],
];

Configure Model's rules

/**
 * @property string[] $attribute1 array of string
 * @property array $attribute2 associative array or just array
 * @property integer|string|\DateTime $attribute3 for more information about the type see \Yii::$app->formatter->asDatetime()
 */
class Model extends ActiveRecord
{
    //...
    public function rules()
    {
        return [
            [['attribute1'], 'each', 'rule' => ['string']],
            [['attribute2'], 'safe'],
        ];
    }
}

Usage

You can then save array, json and timestamp types in database as follows:

/**
 * @var ActiveRecord $model
 */
$model->attribute1 = ['some', 'values', 'of', 'array'];
$model->attribute2 = ['some' => 'values', 'of' => 'array'];
$model->save();

and then use them in your code

/**
 * @var ActiveRecord $model
 */
$model = Model::findOne($pk);
$model->attribute1; // is array
$model->attribute2; // is associative array (decoded json)

Composite types

License

MIT

i-excellent / yii2-pgsql-schema

Maintainers

Details