©
本文档使用 PHP中文网手册 发布
格式化响应
响应格式
当处理一个 RESTful API 请求时， 一个应用程序通常需要如下步骤 来处理响应格式：
- 确定可能影响响应格式的各种因素， 例如媒介类型， 语言， 版本， 等等。 这个过程也被称为 content negotiation。
- 资源对象转换为数组， 如在 Resources 部分中所描述的。 通过 yii\rest\Serializer 来完成。
- 通过内容协商步骤将数组转换成字符串。 [yii\web\ResponseFormatterInterface|response formatters]] 通过 [yii\web\Response::formatters|response]] 应用程序组件来注册完成。
内容协商
Yii 提供了通过 yii\filters\ContentNegotiator 过滤器支持内容协商。RESTful API 基于 控制器类 yii\rest\Controller 在 contentNegotiator下配备这个过滤器。 文件管理器提供了涉及的响应格式和语言。 例如， 如果一个 RESTful API 请求中包含以下 header，
Accept: application/json; q=1.0, */*; q=0.1
将会得到JSON格式的响应，如下：
$ curl -i -H "Accept: application/json; q=1.0, *
defined('YII_DEBUG') or define('YII_DEBUG', true);
require(__DIR__ . '/vendor/autoload.php');
require(__DIR__ . '/vendor/yiisoft/yii2/Yii.php');
$config = require(__DIR__ . '/config/console.php');
$application = new yii\console\Application($config);
$exitCode = $application->run();
exit($exitCode);
该脚本将被创建为你应用程序中的一部分；你可以根据你的需求来修改它。如果你不需要记录错误信息或者希望提高整体性能，YII_DEBUG 常数应定义为 false。 在基本的和高级的两个应用程序模板中，控制台应用程序的入口脚本在默认情况下会启用调试模式，以提供给开发者更好的环境。
配置
在上面的代码中可以看到，控制台应用程序使用它自己的配置文件，名为 console.php 。在该文件里你可以给控制台配置各种 应用组件和属性。
如果你的 web 应用程序和控制台应用程序共享大量的配置参数和值，你可以考虑把这些值放在一个单独的文件中，该文件中包括（ web 和控制台）应用程序配置。 你可以在“高级”项目模板中看到一个例子。
提示：有时，你可能需要使用一个与在入口脚本中指定的应用程序配置不同的控制台命令。例如，你可能想使用
yii migrate命令来升级你的测试数据库，它被配置在每个测试套件。要动态地更改配置，只需指定一个自定义应用程序的配置文件，通过appconfig选项来执行命令：yii <route> --appconfig=path/to/config.php ...
创建你自己的控制台命令
控制台的控制器和行为
一个控制台命令继承自 yii\console\Controller 控制器类。 在控制器类中，定义一个或多个与控制器的子命令相对应的动作。在每一个动作中，编写你的代码实现特定的子命令的适当的任务。
当你运行一个命令时，你需要指定一个控制器的路由。例如，路由 migrate/create 调用子命令对应的yii\console\controllers\MigrateController::actionCreate() 动作方法。 如果在执行过程中提供的路由不包含路由 ID ，将执行默认操作（如 web 控制器）。
选项
通过覆盖在 yii\console\Controller::options() 中的方法，你可以指定可用于控制台命令（controller/actionID）选项。这个方法应该返回控制器类的公共属性的列表。 当运行一个命令，你可以指定使用语法 --OptionName=OptionValue 选项的值。 这将分配 OptionValue 到控制器类的 OptionName 属性。
If the default value of an option is of an array type and you set this option while running the command, the option value will be converted into an array by splitting the input string on any commas.
参数
除了选项，命令还可以接收参数。参数将传递给请求的子命令对应的操作方法。第一个参数对应第一个参数，第二个参数对应第二个参数，依次类推。 命令被调用时，如果没有足够的参数，如果有定义默认值的情况下，则相应的参数将采取默认声明的值；如果没有设置默认值，并且在运行时没有提供任何值，该命令将以一个错误退出。
你可以使用 array 类型提示来指示一个参数应该被视为一个数组。该数组通过拆分输入字符串的逗号来生成。
下面的示例演示如何声明参数：
class ExampleController extends \yii\console\Controller{
// 命令 "yii example/create test" 会调用 "actionCreate('test')"
public function actionCreate($name) { ... }
// 命令 "yii example/index city" 会调用 "actionIndex('city', 'name')"
// 命令 "yii example/index city id" 会调用 "actionIndex('city', 'id')"
public function actionIndex($category, $order = 'name') { ... }
// 命令 "yii example/add test" 会调用 "actionAdd(['test'])"
// 命令 "yii example/add test1,test2" 会调用 "actionAdd(['test1', 'test2'])"
public function actionAdd(array $name) { ... }
}
退出代码
使用退出代码是控制台应用程序开发的最佳做法。通常，执行成功的命令会返回 0。如果命令返回一个非零数字，会认为出现错误。 该返回的数字作为出错代码，用以了解错误的详细信息。例如 1 可能代表一个未知的错误，所有的代码都将保留在特定的情况下：输入错误，丢失的文件等等。
要让控制台命令返回一个退出代码，只需在控制器操作方法中返回一个整数：
public function actionIndex(){
if () {
echo "A problem occured!\n";
return 1;
}
// do something
return 0;
}
你可以使用一些预定义的常数：
-
Controller::EXIT_CODE_NORMAL值为0; -
Controller::EXIT_CODE_ERROR值为1.
为控制器定义有意义的常量，以防有更多的错误代码类型，这会是一个很好的实践。
格式和颜色
Yii 支持格式化输出，如果终端运行命令不支持的话则会自动退化为非格式化输出。
要输出格式的字符串很简单。以下展示了如何输出一些加粗的文字：
$this->stdout("Hello?\n", Console::BOLD);
如果你需要建立字符串动态结合的多种样式，最好使用 ansiFormat ：
$name = $this->ansiFormat('Alex', Console::FG_YELLOW);
echo "Hello, my name is $name.";