mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 06:37:55 +08:00
324 lines
10 KiB
PHP
324 lines
10 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\console\controllers;
|
|
|
|
use Yii;
|
|
use yii\console\Controller;
|
|
use yii\console\Exception;
|
|
use yii\helpers\Console;
|
|
use yii\helpers\FileHelper;
|
|
use yii\test\FixtureTrait;
|
|
|
|
/**
|
|
* Manages loading and unloading fixtures.
|
|
*
|
|
* ~~~
|
|
* #load fixtures from UsersFixture class with default namespace "tests\unit\fixtures"
|
|
* yii fixture/load User
|
|
*
|
|
* #also a short version of this command (generate action is default)
|
|
* yii fixture User
|
|
*
|
|
* #load fixtures with different namespace.
|
|
* yii fixture/load User --namespace=alias\my\custom\namespace\goes\here
|
|
* ~~~
|
|
*
|
|
* @author Mark Jebri <mark.github@yandex.ru>
|
|
* @since 2.0
|
|
*/
|
|
class FixtureController extends Controller
|
|
{
|
|
use FixtureTrait;
|
|
|
|
/**
|
|
* type of fixture apply to database
|
|
*/
|
|
const APPLY_ALL = 'all';
|
|
|
|
/**
|
|
* @var string controller default action ID.
|
|
*/
|
|
public $defaultAction = 'load';
|
|
/**
|
|
* @var string default namespace to search fixtures in
|
|
*/
|
|
public $namespace = 'tests\unit\fixtures';
|
|
/**
|
|
* @var array global fixtures that should be applied when loading and unloading. By default it is set to `InitDbFixture`
|
|
* that disables and enables integrity check, so your data can be safely loaded.
|
|
*/
|
|
public $globalFixtures = [
|
|
'yii\test\InitDb',
|
|
];
|
|
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function options($actionId)
|
|
{
|
|
return array_merge(parent::options($actionId), [
|
|
'namespace', 'globalFixtures'
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Loads given fixture. You can load several fixtures specifying
|
|
* their names separated with commas, like: User,UserProfile,MyCustom. Be sure there is no
|
|
* whitespace between names. Note that if you are loading fixtures to storage, for example: database or nosql,
|
|
* storage will not be cleared, data will be appended to already existed.
|
|
* @param array $fixtures
|
|
* @param array $except
|
|
* @throws \yii\console\Exception
|
|
*/
|
|
public function actionLoad(array $fixtures, array $except = [])
|
|
{
|
|
$foundFixtures = $this->findFixtures($fixtures);
|
|
|
|
if (!$this->needToApplyAll($fixtures[0])) {
|
|
$notFoundFixtures = array_diff($fixtures, $foundFixtures);
|
|
|
|
if ($notFoundFixtures) {
|
|
$this->notifyNotFound($notFoundFixtures);
|
|
}
|
|
}
|
|
|
|
if (!$foundFixtures) {
|
|
throw new Exception(
|
|
"No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" .
|
|
"Check that files with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"."
|
|
);
|
|
}
|
|
|
|
if (!$this->confirmLoad($foundFixtures, $except)) {
|
|
return self::EXIT_CODE_NORMAL;
|
|
}
|
|
|
|
$filtered = array_diff($foundFixtures, $except);
|
|
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures, $filtered));
|
|
|
|
if (!$fixtures) {
|
|
throw new Exception('No fixtures were found in namespace: "' . $this->namespace . '"' . '');
|
|
}
|
|
|
|
$fixturesObjects = $this->createFixtures($fixtures);
|
|
$this->unloadFixtures($fixturesObjects);
|
|
$this->loadFixtures($fixturesObjects);
|
|
$this->notifyLoaded($fixtures);
|
|
}
|
|
|
|
/**
|
|
* Unloads given fixtures. You can clear environment and unload multiple fixtures by specifying
|
|
* their names separated with commas, like: User,UserProfile,MyCustom. Be sure there is no
|
|
* whitespace between names.
|
|
* @param array|string $fixtures
|
|
* @param array|string $except
|
|
* @throws \yii\console\Exception in case no fixtures are found.
|
|
*/
|
|
public function actionUnload(array $fixtures, array $except = [])
|
|
{
|
|
$foundFixtures = $this->findFixtures($fixtures);
|
|
|
|
if (!$this->needToApplyAll($fixtures[0])) {
|
|
$notFoundFixtures = array_diff($fixtures, $foundFixtures);
|
|
|
|
if ($notFoundFixtures) {
|
|
$this->notifyNotFound($notFoundFixtures);
|
|
}
|
|
}
|
|
|
|
if (!$foundFixtures) {
|
|
throw new Exception(
|
|
"No files were found by name: \"" . implode(', ', $fixtures) . "\".\n" .
|
|
"Check that fixtures with these name exists, under fixtures path: \n\"" . $this->getFixturePath() . "\"."
|
|
);
|
|
}
|
|
|
|
if (!$this->confirmUnload($foundFixtures, $except)) {
|
|
return self::EXIT_CODE_NORMAL;
|
|
}
|
|
|
|
$filtered = array_diff($foundFixtures, $except);
|
|
$fixtures = $this->getFixturesConfig(array_merge($this->globalFixtures, $filtered));
|
|
|
|
if (!$fixtures) {
|
|
throw new Exception('No fixtures were found in namespace: ' . $this->namespace . '".');
|
|
}
|
|
|
|
$this->unloadFixtures($this->createFixtures($fixtures));
|
|
$this->notifyUnloaded($fixtures);
|
|
}
|
|
|
|
/**
|
|
* Notifies user that fixtures were successfully loaded.
|
|
* @param array $fixtures
|
|
*/
|
|
private function notifyLoaded($fixtures)
|
|
{
|
|
$this->stdout("Fixtures were successfully loaded from namespace:\n", Console::FG_YELLOW);
|
|
$this->stdout("\t\"" . Yii::getAlias($this->namespace) . "\"\n\n", Console::FG_GREEN);
|
|
$this->outputList($fixtures);
|
|
}
|
|
|
|
/**
|
|
* Notifies user that fixtures were successfully unloaded.
|
|
* @param array $fixtures
|
|
*/
|
|
private function notifyUnloaded($fixtures)
|
|
{
|
|
$this->stdout("Fixtures were successfully unloaded from namespace:\n", Console::FG_YELLOW);
|
|
$this->stdout("\t\"" . Yii::getAlias($this->namespace) . "\"\n\n", Console::FG_GREEN);
|
|
$this->outputList($fixtures);
|
|
}
|
|
|
|
/**
|
|
* Notifies user that fixtures were not found under fixtures path.
|
|
* @param array $fixtures
|
|
*/
|
|
private function notifyNotFound($fixtures)
|
|
{
|
|
$this->stdout("Some fixtures were not found under path:\n", Console::BG_RED);
|
|
$this->stdout("\t" . $this->getFixturePath() . "\n\n", Console::FG_GREEN);
|
|
$this->stdout("Check that they have correct namespace \"{$this->namespace}\" \n", Console::BG_RED);
|
|
$this->outputList($fixtures);
|
|
$this->stdout("\n");
|
|
}
|
|
|
|
/**
|
|
* Prompts user with confirmation if fixtures should be loaded.
|
|
* @param array $fixtures
|
|
* @param array $except
|
|
* @return boolean
|
|
*/
|
|
private function confirmLoad($fixtures, $except)
|
|
{
|
|
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW);
|
|
$this->stdout("\t" . $this->namespace . "\n\n", Console::FG_GREEN);
|
|
|
|
if (count($this->globalFixtures)) {
|
|
$this->stdout("Global fixtures will be loaded:\n\n", Console::FG_YELLOW);
|
|
$this->outputList($this->globalFixtures);
|
|
}
|
|
|
|
$this->stdout("\nFixtures below will be loaded:\n\n", Console::FG_YELLOW);
|
|
$this->outputList($fixtures);
|
|
|
|
if (count($except)) {
|
|
$this->stdout("\nFixtures that will NOT be loaded: \n\n", Console::FG_YELLOW);
|
|
$this->outputList($except);
|
|
}
|
|
|
|
return $this->confirm("\nLoad above fixtures?");
|
|
}
|
|
|
|
/**
|
|
* Prompts user with confirmation for fixtures that should be unloaded.
|
|
* @param array $fixtures
|
|
* @param array $except
|
|
* @return boolean
|
|
*/
|
|
private function confirmUnload($fixtures, $except)
|
|
{
|
|
$this->stdout("Fixtures namespace is: \n", Console::FG_YELLOW);
|
|
$this->stdout("\t" . $this->namespace . "\n\n", Console::FG_GREEN);
|
|
|
|
if (count($this->globalFixtures)) {
|
|
$this->stdout("Global fixtures will be unloaded:\n\n", Console::FG_YELLOW);
|
|
$this->outputList($this->globalFixtures);
|
|
}
|
|
|
|
$this->stdout("\nFixtures below will be unloaded:\n\n", Console::FG_YELLOW);
|
|
$this->outputList($fixtures);
|
|
|
|
if (count($except)) {
|
|
$this->stdout("\nFixtures that will NOT be unloaded:\n\n", Console::FG_YELLOW);
|
|
$this->outputList($except);
|
|
}
|
|
|
|
return $this->confirm("\nUnload fixtures?");
|
|
}
|
|
|
|
/**
|
|
* Outputs data to the console as a list.
|
|
* @param array $data
|
|
*/
|
|
private function outputList($data)
|
|
{
|
|
foreach ($data as $index => $item) {
|
|
$this->stdout("\t" . ($index + 1) . ". {$item}\n", Console::FG_GREEN);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if needed to apply all fixtures.
|
|
* @param string $fixture
|
|
* @return bool
|
|
*/
|
|
public function needToApplyAll($fixture)
|
|
{
|
|
return $fixture == self::APPLY_ALL;
|
|
}
|
|
|
|
/**
|
|
* @param array $fixtures
|
|
* @return array Array of found fixtures. These may differ from input parameter as not all fixtures may exists.
|
|
*/
|
|
private function findFixtures(array $fixtures)
|
|
{
|
|
$fixturesPath = $this->getFixturePath();
|
|
|
|
$filesToSearch = ['*Fixture.php'];
|
|
if (!$this->needToApplyAll($fixtures[0])) {
|
|
$filesToSearch = [];
|
|
foreach ($fixtures as $fileName) {
|
|
$filesToSearch[] = $fileName . 'Fixture.php';
|
|
}
|
|
}
|
|
|
|
$files = FileHelper::findFiles($fixturesPath, ['only' => $filesToSearch]);
|
|
$foundFixtures = [];
|
|
|
|
foreach ($files as $fixture) {
|
|
$foundFixtures[] = basename($fixture, 'Fixture.php');
|
|
}
|
|
|
|
return $foundFixtures;
|
|
}
|
|
|
|
/**
|
|
* Returns valid fixtures config that can be used to load them.
|
|
* @param array $fixtures fixtures to configure
|
|
* @return array
|
|
*/
|
|
private function getFixturesConfig($fixtures)
|
|
{
|
|
$config = [];
|
|
|
|
foreach ($fixtures as $fixture) {
|
|
|
|
$isNamespaced = (strpos($fixture, '\\') !== false);
|
|
$fullClassName = $isNamespaced ? $fixture . 'Fixture' : $this->namespace . '\\' . $fixture . 'Fixture';
|
|
|
|
if (class_exists($fullClassName)) {
|
|
$config[] = $fullClassName;
|
|
}
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
|
|
/**
|
|
* Returns fixture path that determined on fixtures namespace.
|
|
* @return string fixture path
|
|
*/
|
|
private function getFixturePath()
|
|
{
|
|
return Yii::getAlias('@' . str_replace('\\', '/', $this->namespace));
|
|
}
|
|
}
|