0 フォロワー

トレイト yii\test\FileFixtureTrait

実装元	yii\test\ActiveFixture, yii\test\ArrayFixture, yii\test\BaseActiveFixture
利用可能なバージョン	2.0.14
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/test/FileFixtureTrait.php

FileFixtureTrait は、ファイルからデータフィクスチャをロードする機能を提供します。

公開プロパティ

継承されたプロパティを隠す

プロパティ	型	説明	定義元
$dataDirectory	string	フィクスチャデータを含むディレクトリパスまたはパスエイリアス	yii\test\FileFixtureTrait
$dataFile	string\|boolean	getData()によって返されるフィクスチャデータを含むデータファイルのファイルパスまたはパスエイリアス。	yii\test\FileFixtureTrait

保護されたメソッド

継承されたメソッドを隠す

メソッド	説明	定義元
loadData()	フィクスチャデータを返します。	yii\test\FileFixtureTrait

プロパティの詳細

継承されたプロパティを隠す

$dataDirectory public プロパティ

フィクスチャデータを含むディレクトリパスまたはパスエイリアス

public string $dataDirectory = null

$dataFile public プロパティ

getData()によって返されるフィクスチャデータを含むデータファイルのファイルパスまたはパスエイリアス。このプロパティを false に設定すると、データのロードを防止できます。

public string|boolean $dataFile = null

メソッドの詳細

継承されたメソッドを隠す

loadData() protected メソッド

フィクスチャデータを返します。

デフォルトの実装では、$dataFile で指定された外部ファイルを含めることによってフィクスチャデータを返そうとします。このファイルは、データベースに挿入後、data に格納されるデータ配列を返す必要があります。

protected array loadData ( $file, $throwException = true )
$file	string	データファイルのパス
$throwException	boolean	フィクスチャデータファイルが存在しない場合に例外をスローするかどうか。
return	array	データベースに格納されるデータ
throws	yii\base\InvalidConfigException	指定されたデータファイルが存在しない場合。

ソースコード

                protected function loadData($file, $throwException = true)
{
    if ($file === null || $file === false) {
        return [];
    }
    if (basename($file) === $file && $this->dataDirectory !== null) {
        $file = $this->dataDirectory . '/' . $file;
    }
    $file = Yii::getAlias($file);
    if (is_file($file)) {
        return require $file;
    }
    if ($throwException) {
        throw new InvalidConfigException("Fixture data file does not exist: {$file}");
    }
    return [];
}