Permalink
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (55 sloc) 1.95 KB
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
namespace yii\test;
use Yii;
use yii\base\InvalidConfigException;
/**
* FileFixtureTrait provides functionalities for loading data fixture from file.
*
* @author Leandro Guindani Gehlen <leandrogehlen@gmail.com>
* @since 2.0.14
*/
trait FileFixtureTrait
{
/**
* @var string the directory path or [path alias](guide:concept-aliases) that contains the fixture data
*/
public $dataDirectory;
/**
* @var string|bool the file path or [path alias](guide:concept-aliases) of the data file that contains the fixture data
* to be returned by [[getData()]]. You can set this property to be false to prevent loading any data.
*/
public $dataFile;
/**
* Returns the fixture data.
*
* The default implementation will try to return the fixture data by including the external file specified by [[dataFile]].
* The file should return the data array that will be stored in [[data]] after inserting into the database.
*
* @param string $file the data file path
* @param bool $throwException whether to throw exception if fixture data file does not exist.
* @return array the data to be put into the database
* @throws InvalidConfigException if the specified data file does not exist.
*/
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 [];
}
}