Skip to content

[Sync-En] Locale::parseLocale: document that an empty string uses the default locale #1318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lacatoire wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Sync-En] Locale::parseLocale: document that an empty string uses the default locale #1318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 36 additions & 13 deletions reference/intl/locale/parse-locale.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: 815ee7695d8cd08a613bd94b9e52eae6692f77a8 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<!-- CREDITS: DAnnebicque -->
<refentry xml:id="locale.parselocale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
Expand Down Expand Up @@ -38,11 +38,13 @@
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<para>
<simpara>
La configuración regional de la cual extraer el array. Tenga en cuenta que 'variant' y
'private' pueden tomar hasta 15 valores como máximo, mientras que
'extlang' puede tomar hasta 3 valores.
</para>
'extlang' puede tomar hasta 3 valores. Si se pasa un string vacío, se
utiliza en su lugar el valor devuelto por
<function>locale_get_default</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -51,18 +53,15 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Devuelve un array que contiene la lista de pares clave-valor, donde las
claves son los nombres de los elementos, y los valores son su valor asociado.
El array está ordenado de la misma manera que los elementos en la configuración regional,
por ejemplo, si las variantes son '-varX-varY-varZ' entonces el array devuelto
contendrá variant0=&gt;varX, variant1=&gt;varY,
variant2=&gt;varZ, etc.
</para>
<para>
Devuelve &null; cuando el tamaño de <parameter>locale</parameter> excede
<constant>INTL_MAX_LOCALE_LEN</constant>.
</para>
por ejemplo, si las variantes son <literal>-varX-varY-varZ</literal> entonces el array devuelto
contendrá <literal>variant0=&gt;varX</literal>,
<literal>variant1=&gt;varY</literal>, <literal>variant2=&gt;varZ</literal>.
</simpara>
&intl.locale-len.return;
</refsect1>

<refsect1 role="examples">
Expand Down Expand Up @@ -101,6 +100,28 @@ if ($arr) {
<screen>
<![CDATA[
language : sl , script : Latn , region : IT , variant0 : NEDIS ,
]]>
</screen>
<example>
<title>Un string vacío utiliza la configuración regional predeterminada</title>
<programlisting role="php">
<![CDATA[
<?php
locale_set_default('fr-Latn-FR');
$arr = locale_parse('');
if ($arr) {
foreach ($arr as $key => $value) {
echo "$key : $value , ";
}
}
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
language : fr , script : Latn , region : FR ,
]]>
</screen>
</refsect1>
Expand All @@ -110,6 +131,8 @@ language : sl , script : Latn , region : IT , variant0 : NEDIS ,
<para>
<simplelist>
<member><function>locale_compose</function></member>
<member><function>locale_get_default</function></member>
<member><function>locale_set_default</function></member>
</simplelist>
</para>
</refsect1>
Expand Down