From 0ec8ed84e0d1cb014235412ecb64ba53be8c62f2 Mon Sep 17 00:00:00 2001 From: funson86 <funson86@gmail.com> Date: Sun, 26 Oct 2014 22:31:49 +0800 Subject: [PATCH] for check --- docs/guide-zh-CN/output-formatter.md | 145 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------------------------------- 1 file changed, 99 insertions(+), 46 deletions(-) diff --git a/docs/guide-zh-CN/output-formatter.md b/docs/guide-zh-CN/output-formatter.md index 7ec3d59..1866cac 100644 --- a/docs/guide-zh-CN/output-formatter.md +++ b/docs/guide-zh-CN/output-formatter.md @@ -1,34 +1,44 @@ -Data Formatter +数据格式器 ============== +Yii提供一个格式化类来格式化输出,以使输出数据对终端用户更友好易读, +[[yii\i18n\Formatter]] 是一个助手类,作为 [应用组件](structure-application-components.md) 使用,默认名为`formatter`。 For formatting of outputs Yii provides a formatter class to make data more readable for users. [[yii\i18n\Formatter]] is a helper class that is registered as an [application component](structure-application-components.md) named `formatter` by default. +它提供一些方法用来格式化数据,如日期/时间、数字或其他常用的本地化格式, +两种方式使用格式器: It provides a set of methods for data formatting purpose such as date/time values, numbers and other commonly used formats in a localized way. The formatter can be used in two different ways. +1. 直接使用格式化方法(所有的格式器方法以 `as`做前缀): 1. Using the formatting methods (all formatter methods prefixed with `as`) directly: ```php - echo Yii::$app->formatter->asDate('2014-01-01', 'long'); // output: January 1, 2014 - echo Yii::$app->formatter->asPercent(0.125, 2); // output: 12.50% - echo Yii::$app->formatter->asEmail('cebe@example.com'); // output: <a href="mailto:cebe@example.com">cebe@example.com</a> - echo Yii::$app->formatter->asBoolean(true); // output: Yes - // it also handles display of null values: - echo Yii::$app->formatter->asDate(null); // output: (Not set) + echo Yii::$app->formatter->asDate('2014-01-01', 'long'); // 输出: January 1, 2014 + echo Yii::$app->formatter->asPercent(0.125, 2); // 输出: 12.50% + echo Yii::$app->formatter->asEmail('cebe@example.com'); // 输出: <a href="mailto:cebe@example.com">cebe@example.com</a> + echo Yii::$app->formatter->asBoolean(true); // 输出: Yes + // 也可处理null值的输出显示: + echo Yii::$app->formatter->asDate(null); // 输出: (Not set) ``` -2. Using the [[yii\i18n\Formatter::format()|format()]] method and the format name. - This method is also used by widgets like [[yii\grid\GridView]] and [[yii\widgets\DetailView]] where you can specify - the data format of a column in the widget configuration. +2. 使用 [[yii\i18n\Formatter::format()|format()]] 方法和格式化名, + 该方法也被一些小部件如[[yii\grid\GridView]] 和 [[yii\widgets\DetailView]]使用,在小部件配置中可以指定列的数据格式。 ```php - echo Yii::$app->formatter->format('2014-01-01', 'date'); // output: January 1, 2014 - // you can also use an array to specify parameters for the format method: - // `2` is the value for the $decimals parameter of the asPercent()-method. - echo Yii::$app->formatter->format(0.125, ['percent', 2]); // output: 12.50% + echo Yii::$app->formatter->format('2014-01-01', 'date'); // 输出: January 1, 2014 + // 可使用数组来指定格式化方法的参数: + // `2` 是asPercent()方法的参数$decimals的值 + echo Yii::$app->formatter->format(0.125, ['percent', 2]); // 输出: 12.50% ``` +当[PHP intl extension](http://php.net/manual/en/book.intl.php)安装时,格式器的输出会本地化, +为此可配置格式器的 [[yii\i18n\Formatter::locale|locale]] 属性,如果没有配置, +应用配置 [[yii\base\Application::language|language]] 作为当前区域,更多详情参考 [国际化](tutorial-i18n.md)一节。 +然后格式器根据当前区域为日期和数字选择正确的格式,包括月份和星期也会转换到当前语言, +日期格式也会被 [[yii\i18n\Formatter::timeZone|timeZone]] 参数影响, +该参数如果没有明确配置会使用应用的 [[yii\base\Application::timeZone|from the application]] 参数。 All output of the formatter is localized when the [PHP intl extension](http://php.net/manual/en/book.intl.php) is installed. You can configure the [[yii\i18n\Formatter::locale|locale]] property of the formatter for this. If not configured, the application [[yii\base\Application::language|language]] is used as the locale. See the [section on internationalization](tutorial-i18n.md) for more details. @@ -36,26 +46,35 @@ The Formatter will then choose the correct format for dates and numbers accordin week days translated to the current language. Date formats are also affected by the [[yii\i18n\Formatter::timeZone|timeZone]] which will also be taken [[yii\base\Application::timeZone|from the application]] if not configured explicitly. +日期格式根据不同区域输出不同的结果,如下例所示: For example the date format call will output different results for different locales: ```php Yii::$app->formatter->locale = 'en-US'; -echo Yii::$app->formatter->asDate('2014-01-01'); // output: January 1, 2014 +echo Yii::$app->formatter->asDate('2014-01-01'); // 输出: January 1, 2014 Yii::$app->formatter->locale = 'de-DE'; -echo Yii::$app->formatter->asDate('2014-01-01'); // output: 1. Januar 2014 +echo Yii::$app->formatter->asDate('2014-01-01'); // 输出: 1. Januar 2014 Yii::$app->formatter->locale = 'ru-RU'; -echo Yii::$app->formatter->asDate('2014-01-01'); // output: 1 января 2014 г. +echo Yii::$app->formatter->asDate('2014-01-01'); // 输出: 1 января 2014 г. ``` +> 注意不管[PHP intl extension](http://php.net/manual/en/book.intl.php)有没有安装,PHP编译的ICU库不同,格式化结果可能不同, +> 所以为确保不同环境下得到相同的输出,推荐在每个环境下安装PHP intl扩展以及相同的ICU库, +> 可参考: [为国际化设置PHP环境](tutorial-i18n.md#setup-environment). > Note that formatting may differ between different versions of the ICU library compiled with PHP and also based on the fact whether the > [PHP intl extension](http://php.net/manual/en/book.intl.php) is installed or not. So to ensure your website works with the same output > in all environments it is recommended to install the PHP intl extension in all environments and verify that the version of the ICU library > is the same. See also: [Setting up your PHP environment for internationalization](tutorial-i18n.md#setup-environment). +配置格式器 <a name="configuring-format"></a> Configuring the formatter <a name="configuring-format"></a> ------------------------- +可配置[[yii\i18n\Formatter|formatter class]]的属性来调整格式器方法的默认格式, +可以在[应用主体配置](concept-configurations.md#application-configurations) 中配置 `formatter` 组件应用到整个项目, +配置样例如下所示, +更多关于可用属性的详情请参考 [[yii\i18n\Formatter|API documentation of the Formatter class]] 和接下来一小节。 The default formats used by the formatter methods can be adjusted using the properties of the [[yii\i18n\Formatter|formatter class]]. You can adjust these values application wide by configuring the `formatter` component in your [application config](concept-configurations.md#application-configurations). An example configuration is shown in the following. @@ -72,11 +91,18 @@ For more details about the available properties check out the [[yii\i18n\Formatt ], ``` +格式化日期和时间 <a name="date-and-time"></a> Formatting Date and Time values <a name="date-and-time"></a> ------------------------------- +格式器类为格式化日期和时间提供了多个方法: The formatter class provides different methods for formatting date and time values. These are: +- [[yii\i18n\Formatter::asDate()|date]] - 值被格式化成日期,如 `January, 01 2014`. +- [[yii\i18n\Formatter::asTime()|time]] - 值被格式化成时间,如 `14:23`. +- [[yii\i18n\Formatter::asDatetime()|datetime]] - 值被格式化成日期和时间,如 `January, 01 2014 14:23`. +- [[yii\i18n\Formatter::asTimestamp()|timestamp]] - 值被格式化成 [unix 时间戳](http://en.wikipedia.org/wiki/Unix_time) 如 `1412609982`. +- [[yii\i18n\Formatter::asRelativeTime()|relativeTime]] - 值被格式化成和当前时间比较的时间间隔并用人们易读的格式,如`1 hour ago`. - [[yii\i18n\Formatter::asDate()|date]] - the value is formatted as a date e.g. `January, 01 2014`. - [[yii\i18n\Formatter::asTime()|time]] - the value is formatted as a time e.g. `14:23`. - [[yii\i18n\Formatter::asDatetime()|datetime]] - the value is formatted as date and time e.g. `January, 01 2014 14:23`. @@ -84,46 +110,63 @@ The formatter class provides different methods for formatting date and time valu - [[yii\i18n\Formatter::asRelativeTime()|relativeTime]] - the value is formatted as the time interval between a date and now in human readable form e.g. `1 hour ago`. +可配置格式器的属性[[yii\i18n\Formatter::$dateFormat|$dateFormat]], [[yii\i18n\Formatter::$timeFormat|$timeFormat]] +和[[yii\i18n\Formatter::$datetimeFormat|$datetimeFormat]]来全局指定[[yii\i18n\Formatter::asDate()|date]], +[[yii\i18n\Formatter::asTime()|time]] 和 [[yii\i18n\Formatter::asDatetime()|datetime]] 方法的日期和时间格式。 The date and time format for the [[yii\i18n\Formatter::asDate()|date]], [[yii\i18n\Formatter::asTime()|time]], and [[yii\i18n\Formatter::asDatetime()|datetime]] method can be specified globally by configuring the formatters properties [[yii\i18n\Formatter::$dateFormat|$dateFormat]], [[yii\i18n\Formatter::$timeFormat|$timeFormat]], and [[yii\i18n\Formatter::$datetimeFormat|$datetimeFormat]]. +格式器默认会使用一个快捷格式,它根据当前启用的区域来解析, +这样日期和时间会格式化成用户国家和语言通用的格式, +有四种不同的快捷格式: By default the formatter uses a shortcut format that is interpreted differently according to the currently active locale so that dates and times are formatted in a way that is common for the users country and language. There are four different shortcut formats available: -- `short` in `en_GB` locale will print for example `06/10/2014` for date and `15:58` for time, while -- `medium` will print `6 Oct 2014` and `15:58:42`, -- `long` will print `6 October 2014` and `15:58:42 GMT`, -- and `full` will print `Monday, 6 October 2014` and `15:58:42 GMT`. +- `en_GB`区域的 `short` 会打印日期为 `06/10/2014`,时间为 `15:58` +- `medium` 会分别打印 `6 Oct 2014` 和 `15:58:42`, +- `long` 会分别打印 `6 October 2014` 和 `15:58:42 GMT`, +- `full` 会分别打印 `Monday, 6 October 2014` 和 `15:58:42 GMT`. +另外你可使用[ICU 项目](http://site.icu-project.org/) 定义的语法来自定义格式, +ICU项目在该URL:<http://userguide.icu-project.org/formatparse/datetime>下的手册有介绍, +或者可使用PHP [date()](http://php.net/manual/de/function.date.php) 方法的语法字符串并加上前缀`php:`. Additionally you can specify custom formats using the syntax defined by the [ICU Project](http://site.icu-project.org/) which is described in the ICU manual under the following URL: <http://userguide.icu-project.org/formatparse/datetime>. Alternatively you can use the syntax that can be recognized by the PHP [date()](http://php.net/manual/de/function.date.php)-function using a string that is prefixed with `php:`. ```php -// ICU format +// ICU 格式化 echo Yii::$app->formatter->asDate('now', 'yyyy-MM-dd'); // 2014-10-06 -// PHP date()-format +// PHP date()-格式化 echo Yii::$app->formatter->asDate('now', 'php:Y-m-d'); // 2014-10-06 ``` +### 时区 <a name="time-zones"></a> ### Time zones <a name="time-zones"></a> +当格式化日期和时间时,Yii会将它们转换为对应的 [[yii\i18n\Formatter::timeZone|configured time zone]] 时区, +输入的值在没有指定时区时候会被当作UTC时间,因此,推荐存储所有的日期和时间为UTC而不是UNIX时间戳,UNIX通常也是UTC。 +如果输入值所在的时区不同于UTC,时区应明确指定,如下所示: When formatting date and time values, Yii will convert them to the [[yii\i18n\Formatter::timeZone|configured time zone]]. Therefor the input value is assumed to be in UTC unless a time zone is explicitly given. For this reason it is recommended to store all date and time values in UTC preferably as a UNIX timestamp, which is always UTC by definition. If the input value is in a time zone different from UTC, the time zone has to be stated explicitly like in the following example: ```php -// assuming Yii::$app->timeZone = 'Europe/Berlin'; +// 假定 Yii::$app->timeZone = 'Europe/Berlin'; echo Yii::$app->formatter->asTime(1412599260); // 14:41:00 echo Yii::$app->formatter->asTime('2014-10-06 12:41:00'); // 14:41:00 echo Yii::$app->formatter->asTime('2014-10-06 14:41:00 CEST'); // 14:41:00 ``` +> 注意:时区从属于全世界各国政府定的规则,可能会频繁的变更,因此你的系统的时区数据库可能不是最新的信息, +> 可参考 [ICU manual](http://userguide.icu-project.org/datetime/timezone#TOC-Updating-the-Time-Zone-Data) +> 关于更新时区数据库的详情, +> 也可参考:[为国际化设置PHP环境](tutorial-i18n.md#setup-environment). > Note: As time zones are subject to rules made by the governments around the world and may change frequently, it is > likely that you do not have the latest information in the time zone database installed on your system. > You may refer to the [ICU manual](http://userguide.icu-project.org/datetime/timezone#TOC-Updating-the-Time-Zone-Data) @@ -131,11 +174,20 @@ echo Yii::$app->formatter->asTime('2014-10-06 14:41:00 CEST'); // 14:41:00 > See also: [Setting up your PHP environment for internationalization](tutorial-i18n.md#setup-environment). +格式化数字 <a name="numbers"></a> Formatting Numbers <a name="numbers"></a> ------------------ +格式器类提供如下方法格式化数值: For formatting numeric values the formatter class provides the following methods: +- [[yii\i18n\Formatter::asInteger()|integer]] - 值被格式化成整型,如 `42`. +- [[yii\i18n\Formatter::asDecimal()|decimal]] - 值被格式化成十进制数字并带有小数位和千分位,如 `42.123`. +- [[yii\i18n\Formatter::asPercent()|percent]] - 值被格式化成百分率,如 `42%`. +- [[yii\i18n\Formatter::asScientific()|scientific]] - 值被格式化成科学计数型,如`4.2E4`. +- [[yii\i18n\Formatter::asCurrency()|currency]] - 值被格式化成货币格式,如 `£420.00`. +- [[yii\i18n\Formatter::asSize()|size]] - 字节值被格式化成易读的值,如 `410 kibibytes`. +- [[yii\i18n\Formatter::asShortSize()|shortSize]] - [[yii\i18n\Formatter::asSize()|size]] 的缩写值,如 `410 KiB`. - [[yii\i18n\Formatter::asInteger()|integer]] - the value is formatted as an integer e.g. `42`. - [[yii\i18n\Formatter::asDecimal()|decimal]] - the value is formatted as a decimal number considering decimal and thousand separators e.g. `42.123`. - [[yii\i18n\Formatter::asPercent()|percent]] - the value is formatted as a percent number e.g. `42%`. @@ -144,12 +196,17 @@ For formatting numeric values the formatter class provides the following methods - [[yii\i18n\Formatter::asSize()|size]] - the value that is a number of bytes is formatted as a human readable size e.g. `410 kibibytes`. - [[yii\i18n\Formatter::asShortSize()|shortSize]] - is the short version of [[yii\i18n\Formatter::asSize()|size]], e.g. `410 KiB`. +可配置[[yii\i18n\Formatter::decimalSeparator|decimalSeparator]] 和 [[yii\i18n\Formatter::thousandSeparator|thousandSeparator]] +属性来调整数字格式化的格式,默认和当前区域相同。 The format for number formatting can be adjusted using the [[yii\i18n\Formatter::decimalSeparator|decimalSeparator]] and [[yii\i18n\Formatter::thousandSeparator|thousandSeparator]] which are set by default according to the locale. +更多高级配置, [[yii\i18n\Formatter::numberFormatterOptions]] 和 [[yii\i18n\Formatter::numberFormatterTextOptions]] +可用于配置内部使用 [Numberformatter class](http://php.net/manual/en/class.numberformatter.php) For more advanced configuration, [[yii\i18n\Formatter::numberFormatterOptions]] and [[yii\i18n\Formatter::numberFormatterTextOptions]] can be used to configure the interally used [Numberformatter class](http://php.net/manual/en/class.numberformatter.php) +为调整数字的小数部分的最大值和最小值,可配置如下属性: For example to adjust the maximum and minimum value of fraction digits you can configure this property like the following: ```php @@ -159,32 +216,28 @@ For example to adjust the maximum and minimum value of fraction digits you can c ] ``` +其他格式器 <a name="other"></a> Other formatters <a name="other"></a> ---------------- +除了日期、时间和数字格式化外,Yii提供其他用途提供一些实用的格式器: Additional to date, time and number formatting, Yii provides a set of other useful formatters for different purposes: -- [[yii\i18n\Formatter::asRaw()|raw]] - the value is outputted as is, this is a pseudo-formatter that has no effect except that - `null` values will be formatted using [[nullDisplay]]. -- [[yii\i18n\Formatter::asText()|text]] - the value is HTML-encoded. - This is the default format used by the [GridView DataColumn](output-data-widgets.md#data-column). -- [[yii\i18n\Formatter::asNtext()|ntext]] - the value is formatted as an HTML-encoded plain text with newlines converted - into line breaks. -- [[yii\i18n\Formatter::asParagraphs()|paragraphs]] - the value is formatted as HTML-encoded text paragraphs wrapped - into `<p>` tags. -- [[yii\i18n\Formatter::asHtml()|html]] - the value is purified using [[HtmlPurifier]] to avoid XSS attacks. You can - pass additional options such as `['html', ['Attr.AllowedFrameTargets' => ['_blank']]]`. -- [[yii\i18n\Formatter::asEmail()|email]] - the value is formatted as a `mailto`-link. -- [[yii\i18n\Formatter::asImage()|image]] - the value is formatted as an image tag. -- [[yii\i18n\Formatter::asUrl()|url]] - the value is formatted as a hyperlink. -- [[yii\i18n\Formatter::asBoolean()|boolean]] - the value is formatted as a boolean. By default `true` is rendered - as `Yes` and `false` as `No`, translated to the application language. You adjust this by configuring - the [[yii\i18n\Formatter::booleanFormat]]-property. - -`null`-values <a name="null-values"></a> +- [[yii\i18n\Formatter::asRaw()|raw]] - 输出值和原始值一样,除了`null`值会用[[nullDisplay]]格式化,这是一个伪格式器; +- [[yii\i18n\Formatter::asText()|text]] - 值会经过HTML编码; + 这是[GridView DataColumn](output-data-widgets.md#data-column)默认使用的格式; +- [[yii\i18n\Formatter::asNtext()|ntext]] - 值会格式化成HTML编码的纯文本,新行会转换成换行符; +- [[yii\i18n\Formatter::asParagraphs()|paragraphs]] - 值会转换成HTML编码的文本段落,用`<p>`标签包裹; +- [[yii\i18n\Formatter::asHtml()|html]] - 值会被[[HtmlPurifier]]过滤来避免XSS跨域攻击,可传递附加选项如`['html', ['Attr.AllowedFrameTargets' => ['_blank']]]; +- [[yii\i18n\Formatter::asEmail()|email]] - 值会格式化成 `mailto`-链接; +- [[yii\i18n\Formatter::asImage()|image]] - 值会格式化成图片标签; +- [[yii\i18n\Formatter::asUrl()|url]] - 值会格式化成超链接; +- [[yii\i18n\Formatter::asBoolean()|boolean]] - 值会格式化成布尔型值,默认情况下 `true` 对应 `Yes`,`false` 对应 `No`, + 可根据应用语言配置进行翻译,可以配置[[yii\i18n\Formatter::booleanFormat]]-属性来调整; + +`null`-值 <a name="null-values"></a> ------------- -For values that are `null` in PHP, the formatter class will print a placeholder instead of and empty string which -defaults to `(not set)` translated to the current application language. You can configure the -[[yii\i18n\Formatter::nullDisplay|nullDisplay]]-property to set a custom placeholder. -If you want no special handling for `null` values, you can set [[yii\i18n\Formatter::nullDisplay|nullDisplay]] to `null`. +对于PHP的`null`值,格式器类会打印一个占位符而不是空字符串,空字符串默认会显示对应当前语言`(not set)`, +可配置[[yii\i18n\Formatter::nullDisplay|nullDisplay]]-属性配置一个自定义占位符, +如果对处理`null`值没有特殊要求,可设置[[yii\i18n\Formatter::nullDisplay|nullDisplay]] 为 `null`. -- libgit2 0.27.1