Skip to content

Commit 553f37d

Browse files
lacatoirelacatoire
authored
[Sync-En] ext/intl: correct the offset semantics of localtime, parse and parseToCalendar (#3465)
Translation of php/doc-en#4820 (commit 8871302): on return offset holds the position where parsing ended, whether or not it succeeded, and an out-of-range offset makes parsing fail immediately while leaving offset untouched. The localtime return value is described in full. EN-Revision updated.
1 parent d91cfcb commit 553f37d

3 files changed

Lines changed: 59 additions & 50 deletions

File tree

‎reference/intl/dateformatter/localtime.xml‎

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 8ddf539e5993e427cb1385c5a01b6d2ce971b418 Maintainer: yannick Status: ready -->
3-
<!-- Reviewed: no -->
2+
<!-- EN-Revision: 8871302d240f124f7e9dabac85862e31bf97b442 Maintainer: yannick Status: ready -->
43
<refentry xml:id="intldateformatter.localtime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>IntlDateFormatter::localtime</refname>
@@ -26,59 +25,63 @@
2625
<methodparam><type>string</type><parameter>string</parameter></methodparam>
2726
<methodparam choice="opt"><type>int</type><parameter role="reference">offset</parameter><initializer>&null;</initializer></methodparam>
2827
</methodsynopsis>
29-
<para>
30-
Convertit la chaîne $value en une date décomposée (un &array; de
31-
champs), en commençant à la position $parse_pos et en consommant autant
32-
de caractères que possible.
33-
</para>
28+
<simpara>
29+
Convertit <parameter>string</parameter> en une valeur temporelle décomposée
30+
en champs (un &array; de divers champs), en commençant à
31+
<parameter>offset</parameter> et en consommant autant que possible de la
32+
chaîne d'entrée.
33+
</simpara>
3434
</refsect1>
35-
35+
3636
<refsect1 role="parameters">
3737
&reftitle.parameters;
3838
<para>
3939
<variablelist>
4040
<varlistentry>
4141
<term><parameter>formatter</parameter></term>
4242
<listitem>
43-
<para>
44-
La ressource de formateur <classname>IntlDateFormatter</classname>.
45-
</para>
43+
<simpara>
44+
L'objet <classname>IntlDateFormatter</classname>.
45+
</simpara>
4646
</listitem>
4747
</varlistentry>
4848
<varlistentry>
4949
<term><parameter>string</parameter></term>
5050
<listitem>
51-
<para>
52-
La chaîne à convertir.
53-
</para>
51+
<simpara>
52+
La chaîne à convertir en temps.
53+
</simpara>
5454
</listitem>
5555
</varlistentry>
5656
<varlistentry>
5757
<term><parameter>offset</parameter></term>
5858
<listitem>
59-
<para>
60-
La position à partir de laquelle commencer l'analyse dans la valeur $value.
61-
Les positions commencent à 0. Si aucune erreur ne survient durant l'analyse
62-
de $value, $parse_pos contiendra -1, et sinon, il va contenir la position à laquelle
63-
l'analyse s'est terminée (et l'erreur est survenue). Cette variable va contenir
64-
la position de fin si l'analyse échoue.
65-
Si $parse_pos &gt; strlen($value), l'analyse échoue immédiatement.
66-
</para>
59+
<simpara>
60+
Position à laquelle commencer l'analyse dans <parameter>string</parameter>
61+
(à base zéro).
62+
Au retour, <parameter>offset</parameter> contient la position à laquelle
63+
l'analyse s'est terminée, que celle-ci ait réussi ou non.
64+
Si <parameter>offset</parameter> est négatif ou supérieur à
65+
<literal>strlen($string)</literal>, l'analyse échoue immédiatement et
66+
<parameter>offset</parameter> est laissé inchangé.
67+
</simpara>
6768
</listitem>
6869
</varlistentry>
6970
</variablelist>
7071
</para>
7172
</refsect1>
72-
73-
73+
7474
<refsect1 role="returnvalues">
7575
&reftitle.returnvalues;
76-
<para>
77-
Un tableau d'entier compatible avec localtime : il contient l'heure
78-
sur 24 heures dans le champ tm_hour, &return.falseforfailure;.
79-
</para>
76+
<simpara>
77+
Un tableau associatif d'entiers dont les clés sont celles de
78+
<function>localtime</function>, l'heure étant donnée sur une horloge de
79+
24 heures dans <literal>tm_hour</literal>&return.falseforfailure;.
80+
Il est à noter que <literal>tm_yday</literal> commence ici à 1, alors que
81+
<function>localtime</function> le retourne en commençant à 0.
82+
</simpara>
8083
</refsect1>
81-
84+
8285
<refsect1 role="examples">
8386
&reftitle.examples;
8487
<example>
@@ -94,7 +97,9 @@ $fmt = datefmt_create(
9497
'America/Los_Angeles',
9598
IntlDateFormatter::GREGORIAN
9699
);
100+
97101
$arr = datefmt_localtime($fmt, 'Wednesday, December 31, 1969 at 4:00:00 PM Pacific Standard Time', $offset);
102+
98103
echo 'Résultat de l\'analyse ';
99104
if ($arr) {
100105
foreach ($arr as $key => $value) {
@@ -111,14 +116,17 @@ if ($arr) {
111116
<programlisting role="php">
112117
<![CDATA[
113118
<?php
119+
114120
$fmt = new IntlDateFormatter(
115121
'en_US',
116122
IntlDateFormatter::FULL,
117123
IntlDateFormatter::FULL,
118124
'America/Los_Angeles',
119125
IntlDateFormatter::GREGORIAN
120126
);
127+
121128
$arr = $fmt->localtime('Wednesday, December 31, 1969 at 4:00:00 PM Pacific Standard Time', $offset);
129+
122130
echo 'Résultat de l\'analyse ';
123131
if ($arr) {
124132
foreach ($arr as $key => $value) {
@@ -138,7 +146,7 @@ tm_mday : 31 , tm_wday : 3 , tm_yday : 365 , tm_mon : 11 , tm_isdst : 0 ,
138146
]]>
139147
</screen>
140148
</refsect1>
141-
149+
142150
<refsect1 role="seealso">
143151
&reftitle.seealso;
144152
<para>

‎reference/intl/dateformatter/parse.xml‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: yannick Status: ready -->
3-
<!-- Reviewed: no -->
2+
<!-- EN-Revision: 8871302d240f124f7e9dabac85862e31bf97b442 Maintainer: yannick Status: ready -->
43
<refentry xml:id="intldateformatter.parse" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
54
<refnamediv>
65
<refname>IntlDateFormatter::parse</refname>
@@ -39,9 +38,9 @@
3938
<varlistentry>
4039
<term><parameter>formatter</parameter></term>
4140
<listitem>
42-
<para>
43-
La ressource de formateur <classname>IntlDateFormatter</classname>.
44-
</para>
41+
<simpara>
42+
L'objet <classname>IntlDateFormatter</classname>.
43+
</simpara>
4544
</listitem>
4645
</varlistentry>
4746
<varlistentry>
@@ -55,14 +54,15 @@
5554
<varlistentry>
5655
<term><parameter>offset</parameter></term>
5756
<listitem>
58-
<para>
59-
La position à partir de laquelle commencer l'analyse dans la valeur <parameter>string</parameter>.
60-
Les positions commencent à 0. Si aucune erreur ne survient durant l'analyse
61-
de <parameter>string</parameter>, <parameter>offset</parameter> contiendra -1, et sinon, il va contenir la position à laquelle
62-
l'analyse s'est terminée (et l'erreur est survenue). Cette variable va contenir
63-
la position de fin si l'analyse échoue.
64-
Si <parameter>offset</parameter> &gt; <code>strlen($string)</code>, l'analyse échoue immédiatement.
65-
</para>
57+
<simpara>
58+
Position à laquelle commencer l'analyse dans <parameter>string</parameter>
59+
(à base zéro).
60+
Au retour, <parameter>offset</parameter> contient la position à laquelle
61+
l'analyse s'est terminée, que celle-ci ait réussi ou non.
62+
Si <parameter>offset</parameter> est négatif ou supérieur à
63+
<literal>strlen($string)</literal>, l'analyse échoue immédiatement et
64+
<parameter>offset</parameter> est laissé inchangé.
65+
</simpara>
6666
</listitem>
6767
</varlistentry>
6868
</variablelist>

‎reference/intl/dateformatter/parsetocalendar.xml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 20687bf9c58232244e41272d118b98ef4af16a69 Maintainer: lacatoire Status: ready -->
2+
<!-- EN-Revision: 8871302d240f124f7e9dabac85862e31bf97b442 Maintainer: lacatoire Status: ready -->
33
<refentry xml:id="intldateformatter.parsetocalendar" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
44
<refnamediv>
55
<refname>IntlDateFormatter::parseToCalendar</refname>
@@ -39,12 +39,13 @@
3939
<term><parameter>offset</parameter></term>
4040
<listitem>
4141
<simpara>
42-
Position à laquelle commencer l'analyse dans <parameter>string</parameter> (à base zéro).
43-
Si aucune erreur ne survient avant que <parameter>string</parameter> ne soit consommée,
44-
<parameter>offset</parameter> contiendra -1, sinon il contiendra la position à laquelle
45-
l'analyse s'est terminée (et où l'erreur est survenue).
46-
Cette variable contiendra la position de fin si l'analyse échoue.
47-
Si <parameter>offset</parameter> &gt; <code>strlen($string)</code>, l'analyse échoue immédiatement.
42+
Position à laquelle commencer l'analyse dans <parameter>string</parameter>
43+
(à base zéro).
44+
Au retour, <parameter>offset</parameter> contient la position à laquelle
45+
l'analyse s'est terminée, que celle-ci ait réussi ou non.
46+
Si <parameter>offset</parameter> est supérieur à
47+
<literal>strlen($string)</literal>, l'analyse échoue immédiatement et
48+
<parameter>offset</parameter> est laissé inchangé.
4849
</simpara>
4950
</listitem>
5051
</varlistentry>

0 commit comments

Comments
 (0)