From 3a52578d4a1bfb20d76e73f2e59394770856029a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B4=94=E4=BA=AE?= Date: Tue, 15 Jan 2019 07:21:59 +0800 Subject: [PATCH] Various docs fixes [skip ci] --- docs/guide-zh-CN/db-query-builder.md | 2 +- docs/guide-zh-CN/input-forms.md | 4 ++-- docs/guide-zh-CN/output-data-providers.md | 12 ++++++------ docs/guide-zh-CN/rest-controllers.md | 18 +++++++++--------- docs/guide-zh-CN/translators.json | 14 ++++++++++++++ 5 files changed, 32 insertions(+), 18 deletions(-) create mode 100644 docs/guide-zh-CN/translators.json diff --git a/docs/guide-zh-CN/db-query-builder.md b/docs/guide-zh-CN/db-query-builder.md index ebc6ef9..199b11d 100644 --- a/docs/guide-zh-CN/db-query-builder.md +++ b/docs/guide-zh-CN/db-query-builder.md @@ -413,7 +413,7 @@ $query->filterWhere([ > Tip: 当一个值为 `null`、空数组、空字符串或者一个只包含空格的字符串时，那么它将被判定为空值。 -类似于 [[yii\db\Query::andWhere()|andWhere()]] 和 [[yii\db\Query::orWhere()|orWhere()]], +类似于 [[yii\db\Query::andWhere()|andWhere()]] 和 [[yii\db\Query::orWhere()|orWhere()]]， 你可以使用 [[yii\db\Query::andFilterWhere()|andFilterWhere()]] 和 [[yii\db\Query::orFilterWhere()|orFilterWhere()]] 方法 来追加额外的过滤条件。 diff --git a/docs/guide-zh-CN/input-forms.md b/docs/guide-zh-CN/input-forms.md index aa88b15..039a6c2 100644 --- a/docs/guide-zh-CN/input-forms.md +++ b/docs/guide-zh-CN/input-forms.md @@ -233,8 +233,8 @@ Pjax::end(); #### 提交按钮和文件上传中的值 -在处理 [[https://github.com/jquery/jquery/issues/2321|files]] 和 -[[https://github.com/jquery/jquery/issues/2321|submit button values]] +在处理 [文件](https://github.com/jquery/jquery/issues/2321) 和 +[提交按钮值](https://github.com/jquery/jquery/issues/2321) 时使用 `jQuery.serializeArray()` 有已知的问题，这将不会被解决，而是被弃用， 以支持 HTML5 中引入的 FormData 类。 diff --git a/docs/guide-zh-CN/output-data-providers.md b/docs/guide-zh-CN/output-data-providers.md index b43480d..921c4c8 100644 --- a/docs/guide-zh-CN/output-data-providers.md +++ b/docs/guide-zh-CN/output-data-providers.md @@ -136,7 +136,7 @@ $provider = new SqlDataProvider([ $models = $provider->getModels(); ``` -> 说明：[[yii\data\SqlDataProvider::totalCount|totalCount]] 的属性只有你需要 +> Info: [[yii\data\SqlDataProvider::totalCount|totalCount]] 的属性只有你需要 分页数据的时候才会用到。这是因为通过 [[yii\data\SqlDataProvider::sql|sql]] 指定的SQL语句将被数据提供者所修改并且只返回当 前页面数据。数据提供者为了正确计算可用页面的数量仍旧需要知道数据项的总数。 @@ -246,19 +246,19 @@ use yii\data\BaseDataProvider; class CsvDataProvider extends BaseDataProvider { /** - * @var string name of the CSV file to read + * @var string 要读取的 CSV 文件的名称 */ public $filename; /** - * @var string|callable name of the key column or a callable returning it + * @var string|callable 键列的名称或返回它的可调用列表 */ public $key; /** * @var SplFileObject */ - protected $fileObject; // SplFileObject is very convenient for seeking to particular line in a file + protected $fileObject; // SplFileObject 非常便于搜索文件中的特定行 /** @@ -355,8 +355,8 @@ $filter = new ActiveDataFilter([ $filterCondition = null; // 您可以从任何来源加载过滤器。例如： -// if you prefer JSON in request body, -// use Yii::$app->request->getBodyParams() below: +// 如果你更喜欢请求体中的 JSON， +// 使用 Yii::$app->request->getBodyParams() 如下： if ($filter->load(\Yii::$app->request->get())) { $filterCondition = $filter->build(); if ($filterCondition === false) { diff --git a/docs/guide-zh-CN/rest-controllers.md b/docs/guide-zh-CN/rest-controllers.md index bfa4af9..739043b 100644 --- a/docs/guide-zh-CN/rest-controllers.md +++ b/docs/guide-zh-CN/rest-controllers.md @@ -2,10 +2,10 @@ =========== 在创建资源类和指定资源格输出式化后， -下一步就是创建控制器操作将资源通过RESTful APIs展现给终端用户。 +下一步就是创建控制器操作将资源通过 RESTful APIs 展现给终端用户。 -Yii 提供两个控制器基类来简化创建RESTful -操作的工作:[[yii\rest\Controller]] 和 [[yii\rest\ActiveController]]， +Yii 提供两个控制器基类来简化创建 RESTful +操作的工作：[[yii\rest\Controller]] 和 [[yii\rest\ActiveController]]， 两个类的差别是后者提供一系列将资源处理成 [Active Record](db-active-record.md) 的操作。 因此如果使用 [Active Record](db-active-record.md) 内置的操作会比较方便，可考虑将控制器类 继承 [[yii\rest\ActiveController]]， @@ -31,8 +31,8 @@ Yii 提供两个控制器基类来简化创建RESTful 例如，提供用户信息的控制器 可命名为 `UserController`。 -创建新的操作和Web应用中创建操作类似， -唯一的差别是Web应用中调用 `render()` 方法渲染一个视图作为返回值， +创建新的操作和 Web 应用中创建操作类似， +唯一的差别是 Web 应用中调用 `render()` 方法渲染一个视图作为返回值， 对于 RESTful 操作直接返回数据， [[yii\rest\Controller::serializer|serializer]] 和 [[yii\web\Response|response object]] 会处理原始数据到请求格式的转换，例如 @@ -127,7 +127,7 @@ public function behaviors() * [[yii\rest\CreateAction|create]]：创建新的资源； * [[yii\rest\UpdateAction|update]]：更新一个存在的资源； * [[yii\rest\DeleteAction|delete]]：删除指定的资源； -* [[yii\rest\OptionsAction|options]]：返回支持的HTTP方法。 +* [[yii\rest\OptionsAction|options]]：返回支持的 HTTP 方法。 所有这些动作通过 [[yii\rest\ActiveController::actions()|actions()]] 方法申明，可覆盖 `actions()` 方法配置或禁用这些动作， 如下所示： @@ -137,10 +137,10 @@ public function actions() { $actions = parent::actions(); - // 禁用"delete" 和 "create" 动作 + // 禁用 "delete" 和 "create" 动作 unset($actions['delete'], $actions['create']); - // 使用"prepareDataProvider()"方法自定义数据provider + // 使用 "prepareDataProvider()" 方法自定义数据 provider $actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider']; return $actions; @@ -148,7 +148,7 @@ public function actions() public function prepareDataProvider() { - // 为"index"动作准备和返回数据provider + // 为 "index" 动作准备和返回数据 provider } ``` diff --git a/docs/guide-zh-CN/translators.json b/docs/guide-zh-CN/translators.json new file mode 100644 index 0000000..902b6cc --- /dev/null +++ b/docs/guide-zh-CN/translators.json @@ -0,0 +1,14 @@ +[ + "https://www.yiichina.com", + "cuileon", + "qiansen1386", + "deepziyu", + "shi-yang", + "iyuanc", + "xiaoliushifu", + "jhq0113", + "funson86", + "riverlet", + "abrahamgreyson", + "fengyh" +]