CacheController.php 1.04 KB
Newer Older
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
 * @license http://www.yiiframework.com/license/
 */

namespace yii\console\controllers;

use yii\console\Controller;
use yii\console\Exception;
use yii\caching\Cache;

/**
 * This command allows you to flush cache.
 *
 * @author Alexander Makarov <sam@rmcreative.ru>
 * @since 2.0
 */
class CacheController extends Controller
{
	public function actionIndex()
	{
		$this->forward('help/index', array('-args' => array('cache/flush')));
	}

	/**
	 * Flushes cache.
	 * @param string $component Name of the cache application component to use.
	 *
	 * @throws \yii\console\Exception
	 */
	public function actionFlush($component = 'cache')
	{
		/** @var $cache Cache */
		$cache = \Yii::$app->getComponent($component);
		if(!$cache || !$cache instanceof Cache) {
			throw new Exception('Application component "'.$component.'" is not defined or not a cache.');
		}

		if(!$cache->flush()) {
			throw new Exception('Unable to flush cache.');
		}

		echo "\nDone.\n";
	}
}