Skip to content

Commit

Permalink
Merge pull request yiisoft#16115 from yiichina/doc
Browse files Browse the repository at this point in the history
zh-CN translation
  • Loading branch information
samdark authored Apr 17, 2018
2 parents cf09544 + 3dc949e commit 02276a6
Show file tree
Hide file tree
Showing 29 changed files with 1,695 additions and 1,166 deletions.
30 changes: 18 additions & 12 deletions docs/guide-zh-CN/concept-aliases.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
别名(Aliases)
=======
=============

别名用来表示文件路径和 URL,这样就避免了在代码中硬编码一些绝对路径和 URL。
一个别名必须以 `@` 字符开头,以区别于传统的文件路径和 URL。
Yii 预定义了大量可用的别名。例如,别名 `@yii` 指的是 Yii 框架本身的安装目录,而 `@web` 表示的是当前运行应用的根 URL
没有前导 `@` 定义的别名将以 `@` 字符作为前缀

定义别名 <span id="defining-aliases"></span>
----------------
Yii 预定义了大量可用的别名。例如,别名 `@yii` 指的是 Yii 框架本身的安装目录,
`@web` 表示的是当前运行应用的根 URL。

定义别名(Defining Aliases) <span id="defining-aliases"></span>
-------------------------

你可以调用 [[Yii::setAlias()]] 来给文件路径或 URL 定义别名:

Expand All @@ -16,6 +19,9 @@ Yii::setAlias('@foo', '/path/to/foo');

// URL 的别名
Yii::setAlias('@bar', 'http://www.example.com');

// 包含 \foo\Bar 类的具体文件的别名
Yii::setAlias('@foo/Bar.php', '/definitely/not/foo/Bar.php');
```

> Note: 别名所指向的文件路径或 URL 不一定是真实存在的文件或资源。
Expand Down Expand Up @@ -47,8 +53,8 @@ return [
```


解析别名 <span id="resolving-aliases"></span>
-----------------
解析别名(Resolving Aliases) <span id="resolving-aliases"></span>
--------------------------

你可以调用 [[Yii::getAlias()]] 命令来解析根别名到对应的文件路径或 URL。
同样的页面也可以用于解析衍生别名。例如:
Expand Down Expand Up @@ -79,8 +85,8 @@ echo Yii::getAlias('@foo/bar/file.php'); // 输出:/path2/bar/file.php
`@foo/bar` 未被定义为根别名,最后一行语句会显示为 `/path/to/foo/bar/file.php`


使用别名 <span id="using-aliases"></span>
-------------
使用别名(Using Aliases) <span id="using-aliases"></span>
----------------------

别名在 Yii 的很多地方都会被正确识别,
无需调用 [[Yii::getAlias()]] 来把它们转换为路径/URL。
Expand All @@ -98,8 +104,8 @@ $cache = new FileCache([
请关注 API 文档了解特定属性或方法参数是否支持别名。


预定义的别名 <span id="predefined-aliases"></span>
------------------
预定义的别名(Predefined Aliases) <span id="predefined-aliases"></span>
------------------------------

Yii 预定义了一系列别名来简化常用路径和 URL 的使用:

Expand All @@ -118,8 +124,8 @@ Yii 预定义了一系列别名来简化常用路径和 URL 的使用:
于应用的构造方法内定义的。


扩展的别名 <span id="extension-aliases"></span>
-----------------
扩展的别名(Extension Aliases) <span id="extension-aliases"></span>
----------------------------

每一个通过 Composer 安装的 [扩展](structure-extensions.md) 都自动添加了一个别名。
该别名会以该扩展在 `composer.json` 文件中所声明的根命名空间为名,
Expand Down
15 changes: 7 additions & 8 deletions docs/guide-zh-CN/concept-components.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
组件(Component)
==========
==============

组件是 Yii 应用的主要基石。是 [[yii\base\Component]] 类或其子类的实例。
三个用以区分它和其它类的主要功能有:
Expand Down Expand Up @@ -35,10 +35,10 @@ echo DatePicker::widget([
当继承 [[yii\base\Component]][[yii\base\Object]] 时,
推荐你使用如下的编码风格:

- 若你需要重写构造方法(Constructor),传入 `$config` 作为构造器方法**最后一个**参数,
- 若你需要重写构造方法(Constructor),传入 `$config` 作为构造器方法*最后一个*参数,
然后把它传递给父类的构造方法。
- 永远在你重写的构造方法**结尾处**调用一下父类的构造方法。
- 如果你重写了 [[yii\base\BaseObject::init()]] 方法,请确保你在 `init` 方法的**开头处**调用了父类的 `init` 方法。
- 永远在你重写的构造方法*结尾处*调用一下父类的构造方法。
- 如果你重写了 [[yii\base\BaseObject::init()]] 方法,请确保你在 `init` 方法的*开头处*调用了父类的 `init` 方法。

例子如下:

Expand All @@ -56,7 +56,7 @@ class MyClass extends BaseObject

public function __construct($param1, $param2, $config = [])
{
// ... initialization before configuration is applied
// ... 在应用配置之前初始化

parent::__construct($config);
}
Expand All @@ -65,7 +65,7 @@ class MyClass extends BaseObject
{
parent::init();

// ... initialization after configuration is applied
// ... 应用配置后进行初始化
}
}
```
Expand Down Expand Up @@ -93,6 +93,5 @@ $component = \Yii::createObject([
3.[[yii\base\BaseObject::init()|init()]] 方法内进行初始化后的收尾工作。你可以通过重写此方法,进行一些良品检验,属性的初始化之类的工作。
4. 对象方法调用。

前三步都是在对象的构造方法内发生的。这意味着一旦你获得了一个对象实例,
前三步都是在对象的构造方法内发生的。这意味着一旦你获得了一个对象实例(即一个对象)
那么它就已经初始化就绪可供使用。

20 changes: 10 additions & 10 deletions docs/guide-zh-CN/concept-configurations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
配置
=============
配置(Configurations)
====================

在 Yii 中,创建新对象和初始化已存在对象时广泛使用配置。
配置通常包含被创建对象的类名和一组将要赋值给对象
Expand Down Expand Up @@ -35,7 +35,7 @@ Yii::configure($object, $config);
请注意,如果配置一个已存在的对象,那么配置数组中不应该包含指定类名的 `class` 元素。


## 配置的格式 <span id="configuration-format"></span>
## 配置的格式(Configuration Format) <span id="configuration-format"></span>

一个配置的格式可以描述为以下形式:

Expand Down Expand Up @@ -78,14 +78,14 @@ Yii::configure($object, $config);
```


## 使用配置
## 使用配置(Using Configurations) <span id="using-configurations"></span>

Yii 中的配置可以用在很多场景。本章开头我们展示了如何使用 [[Yii::creatObject()]]
根据配置信息创建对象。本小节将介绍配置的两种
主要用法 —— 配置应用与配置小部件。


### 应用的配置 <span id="application-configurations"></span>
### 应用的配置(Application Configurations) <span id="application-configurations"></span>

[应用](structure-applications.md)的配置可能是最复杂的配置之一。
因为 [[yii\web\Application|application]] 类拥有很多可配置的属性和事件。
Expand Down Expand Up @@ -158,7 +158,7 @@ $config = [
获取更多 `definitions``singletons` 配置项和实际使用的例子。


### 小部件的配置 <span id="widget-configurations"></span>
### 小部件的配置(Widget Configurations) <span id="widget-configurations"></span>

使用[小部件](structure-widgets.md)时,常常需要配置以便自定义其属性。
[[yii\base\Widget::widget()]][[yii\base\Widget::begin()]] 方法都可以用来创建小部件。
Expand All @@ -183,10 +183,10 @@ echo Menu::widget([
请注意,代码中已经给出了类名 `yii\widgets\Menu`,配置数组**不应该**再包含 `class` 键。


## 配置文件 <span id="configuration-files"></span>
## 配置文件(Configuration Files) <span id="configuration-files"></span>

当配置的内容十分复杂,通用做法是将其存储在一或多个 PHP 文件中,
这些文件被称为**配置文件**。一个配置文件返回的是 PHP 数组。
这些文件被称为*配置文件*。一个配置文件返回的是 PHP 数组。
例如,像这样把应用配置信息存储在名为 `web.php` 的文件中:

```php
Expand Down Expand Up @@ -236,7 +236,7 @@ $config = require 'path/to/web.php';
```


## 默认配置 <span id="default-configurations"></span>
## 默认配置(Default Configurations) <span id="default-configurations"></span>

[[Yii::createObject()]] 方法基于[依赖注入容器](concept-di-container.md)实现。
使用 [[Yii::creatObject()]] 创建对象时,可以附加一系列**默认配置**到指定类的任何实例。
Expand All @@ -256,7 +256,7 @@ $config = require 'path/to/web.php';
都配置 `maxButtonCount` 的值。


## 环境常量 <span id="environment-constants"></span>
## 环境常量(Environment Constants) <span id="environment-constants"></span>

配置经常要随着应用运行的不同环境更改。例如在开发环境中,
你可能使用名为 `mydb_dev` 的数据库,
Expand Down
Loading

0 comments on commit 02276a6

Please sign in to comment.