Skip to content

Commit 0640344

Browse files
authored
[Sync EN] Document Locale::isRightToLeft (PHP 8.5) (#2747)
Fixes #2745
1 parent 90debdc commit 0640344

1 file changed

Lines changed: 104 additions & 0 deletions

File tree

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- EN-Revision: ac2b471bbca22b1b77140cf7c67c979d18a0caec Maintainer: lacatoire Status: ready -->
3+
<!-- Reviewed: no -->
4+
<refentry xml:id="locale.isrighttoleft"
5+
xmlns="http://docbook.org/ns/docbook"
6+
xmlns:xlink="http://www.w3.org/1999/xlink">
7+
8+
<refnamediv>
9+
<refname>Locale::isRightToLeft</refname>
10+
<refpurpose>Vérifie si une locale utilise un système d'écriture de droite à gauche</refpurpose>
11+
</refnamediv>
12+
13+
<refsect1 role="description">
14+
&reftitle.description;
15+
<methodsynopsis role="Locale">
16+
<modifier>public</modifier>
17+
<modifier>static</modifier>
18+
<type>bool</type>
19+
<methodname>Locale::isRightToLeft</methodname>
20+
<methodparam choice="opt">
21+
<type>string</type><parameter>locale</parameter>
22+
<initializer>""</initializer>
23+
</methodparam>
24+
</methodsynopsis>
25+
26+
<simpara>
27+
Détermine si une locale utilise un système d'écriture de droite à gauche.
28+
</simpara>
29+
30+
<simpara>
31+
Cette méthode s'appuie sur la bibliothèque ICU et évalue le script dominant
32+
associé à la locale.
33+
</simpara>
34+
35+
<simpara>
36+
Si une chaîne vide est fournie, la locale par défaut est utilisée.
37+
</simpara>
38+
</refsect1>
39+
40+
<refsect1 role="parameters">
41+
&reftitle.parameters;
42+
<variablelist>
43+
<varlistentry>
44+
<term><parameter>locale</parameter></term>
45+
<listitem>
46+
<simpara>
47+
L'identifiant de la locale. Si vide, la locale par défaut est utilisée.
48+
</simpara>
49+
</listitem>
50+
</varlistentry>
51+
</variablelist>
52+
</refsect1>
53+
54+
<refsect1 role="returnvalues">
55+
&reftitle.returnvalues;
56+
<simpara>
57+
Retourne &true; si la locale utilise un système d'écriture de droite à
58+
gauche, ou &false; sinon.
59+
</simpara>
60+
</refsect1>
61+
62+
<refsect1 role="changelog">
63+
&reftitle.changelog;
64+
<informaltable>
65+
<tgroup cols="2">
66+
<thead>
67+
<row>
68+
<entry>&Version;</entry>
69+
<entry>&Description;</entry>
70+
</row>
71+
</thead>
72+
<tbody>
73+
<row>
74+
<entry>8.5.0</entry>
75+
<entry>
76+
Ajout de <methodname>Locale::isRightToLeft</methodname>.
77+
</entry>
78+
</row>
79+
</tbody>
80+
</tgroup>
81+
</informaltable>
82+
</refsect1>
83+
84+
<refsect1 role="examples">
85+
&reftitle.examples;
86+
<example>
87+
<title>Vérifier la direction du texte pour une locale</title>
88+
<programlisting>
89+
<![CDATA[
90+
var_dump(Locale::isRightToLeft('en-US'));
91+
var_dump(Locale::isRightToLeft('ar'));
92+
]]>
93+
</programlisting>
94+
&example.outputs;
95+
<screen>
96+
<![CDATA[
97+
bool(false)
98+
bool(true)
99+
]]>
100+
</screen>
101+
</example>
102+
</refsect1>
103+
104+
</refentry>

0 commit comments

Comments
 (0)