YII2框架使用控制臺命令的方法分析

更新時間：2020年03月18日 11:38:04 作者：懷素真

這篇文章主要介紹了YII2框架使用控制臺命令的方法,結(jié)合實例形式分析了YII2使用控制臺命令的相關(guān)步驟、原理與操作技巧,需要的朋友可以參考下

本文實例講述了YII2框架使用控制臺命令的方法。分享給大家供大家參考，具體如下：

有些時候我們需要通過crontab在后臺跑一些定時腳本，這時候就需要用到控制臺命令了。

我們在commands目錄下創(chuàng)建TestController.php，當然腳本的位置是可以隨意指定的，只需要在config/console.php中配置好就行。

$config = [
	'controllerNamespace' => 'app\commands',
];

TestController.php代碼如下：

<?php

namespace app\commands;

use YII;
use yii\console\Controller;
use yii\console\ExitCode;
use yii\helpers\Console;

//注意控制臺程序必須繼承自yii\console\Controller
class TestController extends Controller
{
  public $param1;
  public $param2;
  public $param3;

  //指定用于控制臺的選項
  public function options($actionID)
  {
    return [
      'param1',
      'param2',
      'param3',
    ];
  }

  //如果這些選項名稱太長，可以取個短的別名
  public function optionAliases()
  {
    return [
      'p1' => 'param1',
      'p2' => 'param2',
      'p3' => 'param3',
    ];
  }

  // 定義控制臺運行的方法
  // yii test/test1 -p1=hello -p2=world -p3=!!!
  public function actionTest1()
  {
    echo $this->param1, ' ', $this->param2, ' ', $this->param3, "\n";
    return ExitCode::OK;
  }

  // 我們可以獲取控制臺傳過來的參數(shù)
  // 注意，函數(shù)第一個參數(shù)，對應控制臺傳過來的第一個參數(shù)，依次類推，不要把順序搞錯了。
  // yii test/test2 aa bb cc
  public function actionTest2($p1 = '', $p2 = '', $p3 = '')
  {
    echo $p1, ' ', $p2, ' ', $p3, "\n";
    return ExitCode::OK;
  }

  // 當然控制臺也可以一次傳多個數(shù)據(jù)過來，這就需要把函數(shù)參數(shù)聲明為一個array
  // 控制臺傳參時就需要把傳遞的數(shù)據(jù)通過逗號連接起來，YII2通過處理變成數(shù)組
  // yii test/test3 aa,bb,cc
  public function actionTest3(array $arr)
  {
    echo implode('--', $arr), "\n";
    return ExitCode::OK;
  }

  // 控制臺格式和顏色的設置
  // yii test/test4
  public function actionTest4()
  {
    //用于控制臺輸出
    $this->stdout('hello', Console::FG_RED);
    $this->stdout('world', Console::FG_GREEN);
    $this->stdout('!!!', Console::FG_BLUE);
    echo "\n";

    $hello = $this->ansiFormat('hello', Console::FG_RED);
    $world = $this->ansiFormat('world', Console::FG_GREEN);
    $sigh = $this->ansiFormat('!!!', Console::FG_BLUE);
    echo $hello, ' ', $world, ' ', $sigh, "\n";
    return ExitCode::OK;
  }
}

運行結(jié)果如下：