tecnocen / yii2-arfixture
Yii2 library to run fixtures the ActiveRecord Dao
Installs: 9 826
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 3
Forks: 0
Open Issues: 5
Type:yii2-extension
Requires
- yiisoft/yii2: ~2.0.0
This package is auto-updated.
Last update: 2024-12-05 07:37:55 UTC
README
Library to load data fixutres using using the methods defined by yii\db\ActiveRecord
and show progress log.
Installation
The preferred way to install this extension is through composer.
Either run
composer require --prefer-dist "tecnocen/yii2-arfixture:*"
or add
"tecnocen/yii2-arfixture": "*"
to the require
section of your composer.json
file.
Differences
yii\test\Fixture
and yii\test\ActiveFixture
load data to the tables using
the name of the table and the yii\db\Schema::insert()
method which means all
the methods defined in the model such as validations, events, behaviors and even
table prefix are ignored.
tecnocen\arfixutre\ARFixture
loads fixtures by creating a model using the
$modelClass
property and then passes by all the workflow of saving the data
using ActiveRecord
considering scenarios, exceptions, events, safe attributes,
validation errors and showing detailed information to the user of the procedure.
Usage
ARFixture
class UserFixture extends ARFixture { public $modelClass = 'common\models\User'; }
If [[$dataFile]] is not defined then it will seek on the data/
subfolder the
file with the same name as this class except for the Fixture
keyword at the
end. Example: UserFixture
will return the file data/User.php
or an empty
array when the file can not found.
The data must follow this structure
return [ // record with no explicit alias, will only show the key number on the log. [ 'username' => 'faryshta', 'name' => 'Angel', 'lastname' => 'Guevara', 'email' => 'angeldelcaos@gmail.com', ], // record with explicit alias, will be shown on the log 'duplicated' => [ 'username' => 'faryshta', 'name' => 'Angel', 'lastname' => 'Guevara', 'email' => 'angeldelcaos@gmail.com', // optional, will apply the scenario before loading the models. 'scenario' => 'api-save', // optional, will check the validation errors. 'attributeErrors' => [ // will check that username has this exact validation error. 'username' => 'Username already in use', // will check that email has any validation error 'email', // the other attributes are not expected to have a validation error. ], ] ];
Each row can contain the following special options:
-
attributeErrors: array list of expected validation errors in the format
'attributeErrors' => [ 'attribute1', // will check that it contains any error. 'attribute2' => 'Error Message' // This has to be the error found. ]
Warning: If this option is defined the record won't be saved even if it passes all the validations.
-
scenario: string to be used as scenario for the model to handle the methods
Model::load()
andModel::validate()
, if not defined the$scenarioDefault
will be used
Documentation
TODO
License
The BSD License (BSD). Please see License File for more information.