[TOC]
* * * * *
## 1 控制臺源代碼
(think/library/think/Console.php)方法列表
~~~
private $name;
private $version;
private $commands = [];
private $wantHelps = false;
private $runningCommand;
private $catchExceptions = true;
private $autoExit = true;
private $definition;
private $helperSet;
private $terminalDimensions;
private $defaultCommand;
~~~
`public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN'){}`
`public function run(){}`
`public function doRun(Input $input, Output $output){}`
`public function setHelperSet(HelperSet $helperSet)`
`public function getHelperSet()`
`public function setDefinition(InputDefinition $definition){}`
`public function getDefinition(){}`
`public function getHelp(){}`
`public function setCatchExceptions($boolean){}`
`public function setAutoExit($boolean){}`
`public function getName(){}`
`public function setName($name){}`
`public function getVersion(){}`
`public function setVersion($version){}`
`public function getLongVersion(){}`
`public function register($name){}`
`public function addCommands(array $commands){}`
`public function get($name){}`
`public function has($name){}`
`public function getNamespaces(){}`
`public function findNamespace($namespace){}`
`public function find($name){}`
`public function all($namespace = null){}`
`public static function getAbbreviations($names){}`
`public function renderException(\Exception $e, Stream $output){}`
`protected function getTerminalWidth(){}`
`protected function getTerminalHeight(){}`
`public function getTerminalDimensions(){}`
`public function setTerminalDimensions($width, $height){}`
`protected function configureIO(Input $input, Output $output){}`
`protected function doRunCommand(Command $command, Input $input, Output $output){}`
`protected function getCommandName(Input $input){}`
`protected function getDefaultInputDefinition(){}`
`protected function getDefaultCommands(){}`
`protected function getDefaultCommands(){}`
`protected function getDefaultHelperSet(){}`
`private function getSttyColumns(){}`
`private function getConsoleMode(){}`
`private function getAbbreviationSuggestions($abbrevs){}`
`public function extractNamespace($name, $limit = null){}`
`private function findAlternatives($name, $collection){}`
`public function setDefaultCommand($commandName){}`
`private function stringWidth($string){}`
`private function splitStringByWidth($string, $width){}`
`private function extractAllNamespaces($name){}`
## 2 文件分析
### 1 成員變量
$name,$version:控制臺的名稱和版本號
$commands:指令集數組
$wantHelps:???
$runningCommand:當前運行指令
$catchException, autoExit:控制臺運行狀態控制
$defintion:輸入參數定義
$helperSet:助手集
$terminalDimensions:終端尺寸
$defaultCommand:默認運行指令
* * * * *
### 2 public方法(30個)
`__construct()` 初始化控制臺
> $name:控制臺名稱
> $version:控制臺版本
* * * * *
`run()` 從輸入獲取指令并執行
* * * * *
`doRun()` 解析指令并運行
> $input:輸入接口
> $output:輸出接口
* * * * *
`setHelperSet() getHelperSet()` 設置和獲取助手集
> $helperSet:助手集參數
* * * * *
`setDefinition() getDefinition()` 設置和獲取輸入參數定義
> $definition:輸入參數定義
* * * * *
`getHelp()` 獲取幫助信息
* * * * *
`setCatchExceptions()` 是否捕獲異常
> $boolean: 設置控制臺參數$catchExceptions
* * * * *
`setAutoExit()` 是否自動退出
> $boolean: 設置控制臺參數$autoExit
* * * * *
`getName() setName() `獲取和設置控制臺名稱
> $name:控制臺名稱參數$name
* * * * *
`getVersion() setVersion()` 獲取和設置控制臺版本
> $version:控制臺版本參數$version
* * * * *
`getLongVersion()` 獲取完整版本的號
添加和獲取指令
* * * * *
`register() addCommands() add() get()
has() find() all()
getAbbreviations()`
> $name 指令名稱
* * * * *
`getNamespaces() findNamespace()` 獲取命名空間信息
* * * * *
`getTerminalDimensions()
setTerminalDimensions()` 獲取和設置終端尺寸信息
* * * * *
`renderException()` 輸出異常信息
* * * * *
`extractNamespace()` 返回指令命名空間部分
* * * * *
`setDefaultCommand()` 設置默認的指令
* * * * *
### 3 protected方法(9個)
`getTerminalWidth() getTerminalHeight() ` 獲取終端寬度和高度
* * * * *
`configureIO()` 配置輸入和輸出對象
* * * * *
`doRunCommand()` 運行指令
* * * * *
`getCommandName()` 獲取指令的基礎名稱
* * * * *
`getDefaultInputDefinition()` 獲取默認輸入定義
* * * * *
`getDefaultCommands()` 設置默認命令
* * * * *
`getDefaultHelperSet()` 設置默認助手
* * * * *
`getSttyColumns()` 獲取stty列數
### 4 Private 私有方法(6個)
`getConsoleMode()` 獲取終端模式
`getAbbreviationSuggestions()` 獲取可能的建議
`findAlternatives()` 查找可替代的建議
`stringWidth()` 字符串長度
`splitStringByWidth()` 字符串切割
`extractAllNamespaces()` 返回所有命名空間
## 3 控制臺的使用
### 3-1 添加命令配置
添加需要執行的命令類名
~~~
application\command.php
return ['think\console\command\Test'];
~~~
### 3-2 命令執行實現
命令類的實現
繼承think\console\command類
實現 configure() execute()方法
~~~
thinkphp\library\think\console\command\Test.php
<?php
namespace think\console\command;
use think\console\Input;
use think\console\Output;
class Test extends Command
{
protected function configure()
{
$this->setName('test')
->setDescription('Command Test');
}
protected function execute(Input $input, Output $output)
{
$output->writeln("TestCommand:");
}
}
~~~
### 3-3 控制臺入口測試
1 打開命令,進入框架根目錄(console文件所在目錄)

2 輸入測試命令 php console test

3 輸出結果

4 在命令實現文件的execute()中添加相應功能即可
## 4 總結
控制臺是tp5新的功能。
其接口是 Console.php文件,
9個成員變量
30個public方法
9個protected方法
6個private方法
實現在[D:(\concole\)控制臺](http://www.hmoore.net/zmwtp/tp5/120858)目錄
- 更新記錄
- 概述
- 文件索引
- 函數索引
- 章節格式
- 框架流程
- 前:章節說明
- 主:(index.php)入口
- 主:(start.php)框架引導
- 主:(App.php)應用啟動
- 主:(App.php)應用調度
- C:(Controller.php)應用控制器
- M:(Model.php)數據模型
- V:(View.php)視圖對象
- 附:(App.php)應用啟動
- 附:(base.php)全局變量
- 附:(common.php)模式配置
- 附:(convention.php)全局配置
- 附:(Loader.php)自動加載器
- 附:(Build.php)自動生成
- 附:(Hook.php)監聽回調
- 附:(Route.php)全局路由
- 附:(Response.php)數據輸出
- 附:(Log.php)日志記錄
- 附:(Exception.php)異常處理
- 框架工具
- 另:(helper.php)輔助函數
- 另:(Cache.php)數據緩存
- 另:(Cookie.php)cookie操作
- 另:(Console.php)控制臺
- 另:(Debug.php)開發調試
- 另:(Error.php)錯誤處理
- 另:(Url.php)Url操作文件
- 另:(Loader.php)加載器實例化
- 另:(Input.php)數據輸入
- 另:(Lang.php)語言包管理
- 另:(ORM.php)ORM基類
- 另:(Process.php)進程管理
- 另:(Session.php)session操作
- 另:(Template.php)模板解析
- 框架驅動
- D:(\config)配置解析
- D:(\controller)控制器擴展
- D:(\model)模型擴展
- D:(\db)數據庫驅動
- D:(\view)模板解析
- D:(\template)模板標簽庫
- D:(\session)session驅動
- D:(\cache)緩存驅動
- D:(\console)控制臺
- D:(\process)進程擴展
- T:(\traits)Trait目錄
- D:(\exception)異常實現
- D:(\log)日志驅動
- 使用范例
- 服務器與框架的安裝
- 控制器操作
- 數據模型操作
- 視圖渲染控制
- MVC開發初探
- 模塊開發
- 入口文件定義全局變量
- 運行模式開發
- 框架配置
- 自動生成應用
- 事件與插件注冊
- 路由規則注冊
- 輸出控制
- 多種應用組織
- 綜合應用
- tp框架整合后臺auto架構快速開發
- 基礎原理
- php默認全局變量
- php的魔術方法
- php命名空間
- php的自動加載
- php的composer
- php的反射
- php的trait機制
- php設計模式
- php的系統時區
- php的異常錯誤
- php的輸出控制
- php的正則表達式
- php的閉包函數
- php的會話控制
- php的接口
- php的PDO
- php的字符串操作
- php的curl
- 框架心得
- 心:整體結構
- 心:配置詳解
- 心:加載器詳解
- 心:輸入輸出詳解
- 心:url路由詳解
- 心:模板詳解
- 心:模型詳解
- 心:日志詳解
- 心:緩存詳解
- 心:控制臺詳解
- 框架更新
- 4.20(驗證類,助手函數)
- 4.27(新模型Model功能)
- 5.4(新數據庫驅動)
- 7.28(自動加載)