# 自动创建类(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 命令
- 开发
- 建立自定义命令
- 注册自定义命令