# 自動創建類(Class)
要創建一個新的自定義命令,您可以使用 make:console 這個 Artisan 命令,這將會自動產生一個 Command stub 協助您開始創建您的自定義命令:
## 自動創建一個新的命令類
~~~
php artisan make:console FooCommand
~~~
上面的命令將會協助你自動創建一個類,并保存為文件 `app/Console/FooCommand.php`。
在創建自定義命令時,加上 `--command` 這個選項,將可以指定之后在終端機使用此自定義命令時,所要輸入的自定義命令名稱:
~~~
php artisan make:console AssignUsers --command=users:assign
~~~
# 撰寫自定義命令
一旦你的自定義命令被創建后,你需要填寫自定義命令的 `名稱(name)` 與 `描述(description)`,您所填寫的內容將會被顯示在 Artisan 的 `list` 畫面中。
當您的自定義命令被執行時,將會調用 `fire` 方法,您可以在此為自定義命令加入任何的邏輯判斷。
# 參數與選項
你可以通過 `getArguments` 與 `getOptions` 為自定義命令自行定義任何需要的參數與選項。這兩個方法都會返回一組命令數組,并由選項數組的清單所組成。
當定義 `arguments` 時,該數組值的定義分別如下:
~~~
[$name, $mode, $description, $defaultValue]
~~~
參數 mode 可以是下列其中一項: `InputArgument::REQUIRED` 或 `InputArgument::OPTIONAL`。
當定義 `options` 時,該數組值的定義分別如下:
~~~
[$name, $shortcut, $mode, $description, $defaultValue]
~~~
對選項而言,參數 `mode` 可以是下列其中一項:`InputOption::VALUE_REQUIRED`, `InputOption::VALUE_OPTIONAL`, `InputOption::VALUE_IS_ARRAY`, `InputOption::VALUE_NONE`。
模式為 `VALUE_IS_ARRAY` 表示調用命令時可以多次使用此選項來傳入多個值:
~~~
InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY
~~~
這個命令將允許:
~~~
php artisan foo --option=bar --option=baz
~~~
模式為 `VALUE_NONE` 則表示將此選項純粹作為一種有或無的「開關」使用:
~~~
php artisan foo --option
~~~
# 取得輸入值(參數與選項)
當您的自定義命令執行時,您需要讓您的應用程序可以訪問到這些參數和選項的值,要做到這一點,您可以使用 `argument` 和 `option` 方法:
## 取得自定義命令被輸入的參數
~~~
$value = $this->argument('name');
~~~
## 取得自定義命令被輸入的所有參數
~~~
$arguments = $this->argument();
~~~
## 取得自定義命令被輸入的選項
~~~
$value = $this->option('name');
~~~
## 取得自定義命令被輸入的所有選項
~~~
$options = $this->option();
~~~
# 產生輸出
想要顯示信息到終端屏幕上,您可以使用 `info`、`comment`、`question` 和 `error` 方法。每一種方法將會依據它所代表的目的,分別對應一種適當的 ANSI 顏色。
## 顯示一般消息到終端屏幕
~~~
$this->info('Display this on the screen');
~~~
## 顯示錯誤消息到終端屏幕
~~~
$this->error('Something went wrong!');
~~~
# 詢問式輸入
您也可以使用 `ask` 和 `confirm` 方法來提示用戶進行輸入:
## 提示用戶進行輸入
~~~
$name = $this->ask('What is your name?');
~~~
提示用戶進行加密輸入
~~~
$password = $this->secret('What is the password?');
~~~
## 提示用戶進行確認
~~~
if ($this->confirm('Do you wish to continue? [yes|no]'))
{
//
}
~~~
您也可以指定一個默認值給 `confirm` 方法,可以是 `true` 或 `false`:
~~~
$this->confirm($question, true);
~~~
# 調用其它命令
有時候您可能希望在您的命令內部調用其它命令,此時您可以使用 `call` 方法:
~~~
$this->call('command:name', ['argument' => 'foo', '--option' => 'bar']);
~~~
- 前言
- 發行說明/L5新特性
- 升級向導
- 升級到 5.0.16
- 從 4.2 升級到 5.0
- 從 4.1 升級到 4.2
- 從 4.1.x 升級到 4.1.29
- 從 4.1.25 升級到 4.1.26
- 從 4.0 升級到 4.1
- 貢獻向導
- 環境配置
- 安裝
- 配置
- 基本功能
- 路由
- 基本路由
- CSRF 保護
- 方法欺騙
- 路由參數
- 命名路由
- 路由群組
- 路由模型綁定
- 拋出 404 錯誤
- 中間件
- 建立中間件
- 注冊中間件
- 可終止中間件
- 控制器
- 基礎控制器
- 控制器中間件
- 隱式控制器
- RESTful 資源控制器
- 請求
- 取得請求實例
- 取得輸入數據
- 舊輸入數據
- Cookies
- 上傳文件
- 其他的請求信息
- 響應
- 基本響應
- 重定向
- 其他響應
- 響應宏
- 系統架構
- 服務提供者
- 基本提供者例子
- 注冊提供者
- 緩載提供者
- 服務容器
- 基本用法
- 將接口綁定到實現
- 上下文綁定
- 標簽
- 實際應用
- 容器事件
- 參考:理解PHP 依賴注入|Laravel IoC容器
- Contracts
- 為什么用 Contracts
- Contract 參考
- 如何使用 Contracts
- Facades
- 實際用法
- 建立 Facades
- 模擬 Facades
- Facade 類參考
- 請求的生命周期
- 生命周期概要
- 聚焦于服務提供者
- 應用程序結構
- 根目錄
- App 目錄
- 為應用程序配置命名空間
- 系統服務
- 認證
- 用戶認證
- 取得經過認證的用戶
- 保護路由
- HTTP 基本認證
- 忘記密碼與重設
- 第三方登陸認證
- 交易
- 配置文件
- 訂購方案
- 一次性付款
- Single Charges
- 免信用卡試用
- 訂購轉換
- 訂購數量
- 取消訂購
- 恢復訂購
- 確認訂購狀態
- 處理失敗訂閱
- 處理其它 Stripe Webhooks
- 收據
- 緩存
- 配置
- 緩存用法
- 遞增與遞減
- 緩存標簽
- 緩存事件
- 數據庫緩存
- 集合
- Command Bus
- 建立命令
- 調用命令
- 命令隊列
- 命令管道
- 核心擴展
- 管理者和工廠
- 緩存
- Session
- 認證
- 基于服務容器的擴展
- Laravel Elixir
- 安裝與配置
- 使用方式
- Gulp
- Custom Tasks and Extensions
- 加密
- Envoy 任務執行器
- 安裝
- 執行任務
- 多服務器
- 并行執行
- 任務宏
- 通知
- 更新 Envoy
- 錯誤與日志
- 配置
- 錯誤處理
- HTTP 異常
- 日志
- 事件
- 基本用法
- 事件處理隊列
- 事件訂閱者
- 文件系統與云存儲
- 配置文件
- 基本用法
- 自定義文件系統
- 哈希
- 基本用法
- 輔助方法
- 數組
- 路徑
- 路由
- 字符串
- 網址(URL)
- 其他
- 本地化
- 語言文件
- 基本用法
- 復數
- 驗證
- 覆寫擴展包的語言文件
- 郵件
- 配置
- 基本用法
- 內嵌附件
- 郵件隊列
- 郵件與本地端開發
- 擴展包開發
- 視圖
- 語言
- 配置文件
- 公共資源
- 發布分類文件
- 路由
- 分頁
- 配置
- 使用
- 追加分頁鏈接
- 轉換至 JSON
- 隊列
- 設置
- 基本用法
- 隊列閉包
- 執行一個隊列監聽
- 常駐隊列處理器
- 推送隊列
- 已失敗的工作
- 會話
- 配置
- 使用 Session
- 暫存數據(Flash Data)
- 數據庫 Sessions
- Session 驅動
- 模板
- Blade 模板
- Blade 控制語法結構
- Blade 擴展
- 參考:@section與@yield 介紹
- 單元測試
- 定義并執行測試
- 測試環境
- 從測試調用路由
- 模擬 Facades
- 框架 Assertions
- 輔助方法
- 重置應用程序
- 表單驗證
- 基本用法
- 控制器驗證
- 表單請求驗證
- 使用錯誤信息
- 錯誤信息 & 視圖
- 可用驗證規則
- 條件驗證規則
- 自定義錯誤信息
- 自定義驗證規則
- 數據庫
- 使用基礎
- 配置
- 讀取/寫入連接
- 執行查找
- 數據庫事務處理
- 獲取連接
- 日志記錄
- 查詢構造器
- Selects
- Joins
- 高級 Wheres
- 聚合
- 原生表達式
- 添加
- 更新
- 刪除
- Unions
- 悲觀鎖定 (Pessimistic Locking)
- Eloquent ORM
- 基本用法
- 批量賦值
- 新增,更新,刪除
- 軟刪除
- 時間戳
- 范圍查詢
- Global Scopes
- 關聯
- 關聯查詢
- 預載入
- 新增關聯模型
- 更新上層時間戳
- 使用樞紐表
- 集合
- 獲取器和修改器
- 日期轉換器
- 屬性類型轉換
- 模型事件
- 模型觀察者
- 模型 URL 生成
- 轉換成數組 / JSON
- 結構生成器
- 建立與刪除數據表
- 加入字段
- 修改字段
- 修改字段名稱
- 移除字段
- 檢查是否存在
- 加入索引
- 外鍵
- 移除索引
- 移除時間戳記和軟刪除
- 保存引擎
- 遷移和數據填充
- 建立遷移文件
- 執行遷移
- 回滾遷移
- 數據填充
- Redis
- 配置
- 使用方式
- 管道
- 開發包
- Confide 用戶身份認證
- Entrust 權限管理
- Shoppingcart 購物車
- Genertators 代碼生成工具
- IDE Helper IDE助手
- Artisan 命令行工具
- 概覽
- 用法
- 在命令行接口以外的地方調用命令
- 定時調用 Artisan 命令
- 開發
- 建立自定義命令
- 注冊自定義命令