<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: ec01a42be50e84f192c0b19fc6e9cf40a0f7ac31 Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no -->

<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.setlocale">

<refnamediv>

<refname>setlocale</refname>

<refpurpose>Establece la información de configuración local</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>setlocale</methodname>

<methodparam><type>int</type><parameter>category</parameter></methodparam>

<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>locales</parameter></methodparam>

<methodparam rep="repeat"><type>string</type><parameter>rest</parameter></methodparam>

</methodsynopsis>

<simpara>Firma alternativa (no soportada con argumentos nombrados):</simpara>

<methodsynopsis>

<type class="union"><type>string</type><type>false</type></type><methodname>setlocale</methodname>

<methodparam><type>int</type><parameter>category</parameter></methodparam>

<methodparam><type>array</type><parameter>locale_array</parameter></methodparam>

</methodsynopsis>

<para>

Establece la información de configuración local.

</para>

<warning>

<para>

La información de configuración local se mantiene por proceso, no por hilo. Si está ejecutando PHP en una API de servidor multihilo,

puede experimentar cambios repentinos en la configuración local mientras se ejecuta un script, aunque el script nunca haya llamado a

<function>setlocale</function>. Esto ocurre debido a otros scripts que se ejecutan en diferentes hilos del mismo proceso al mismo tiempo,

cambiando la configuración local del proceso usando <function>setlocale</function>.

En Windows, la información de configuración local se mantiene por hilo a partir de PHP 7.0.5.

</para>

</warning>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>category</parameter></term>

<listitem>

<para>

<parameter>category</parameter> es una constante nombrada que especifica la

categoría de las funciones afectadas por la configuración local:

<itemizedlist>

<listitem>

<simpara>

<constant>LC_ALL</constant> para todas las categorías siguientes

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_COLLATE</constant> para comparación de strings, ver

<function>strcoll</function>

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_CTYPE</constant> para clasificación y conversión de caracteres, por ejemplo <function>ctype_alpha</function>

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_MONETARY</constant> para <function>localeconv</function>

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_NUMERIC</constant> para el separador decimal (Ver también

<function>localeconv</function>)

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_TIME</constant> para el formato de fecha y hora con

<function>strftime</function>

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LC_MESSAGES</constant> para respuestas del sistema (disponible si PHP fue compilado con

<literal>libintl</literal>)

</simpara>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>locales</parameter></term>

<listitem>

<para>

Si <parameter>locales</parameter> es la cadena vacía

<literal>""</literal> o es &null;, los nombres de configuración local se establecerán a partir de los

valores de las variables de entorno con los mismos nombres que las categorías anteriores, o de "LANG".

</para>

<para>

Si <parameter>locales</parameter> es <literal>"0"</literal>,

la configuración local no se ve afectada, solo se devuelve la configuración actual.

</para>

<para>

Si <parameter>locales</parameter> va seguido de parámetros adicionales, entonces cada parámetro se intenta establecer como

nueva configuración local hasta que tenga éxito. Esto es útil si una configuración local es conocida bajo

diferentes nombres en diferentes sistemas o para proporcionar una alternativa

para una configuración local posiblemente no disponible.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>rest</parameter></term>

<listitem>

<para>

Parámetros opcionales de string para intentar como configuraciones locales hasta

que tenga éxito.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>locale_array</parameter></term>

<listitem>

<para>

Cada elemento del array se intenta establecer como

nueva configuración local hasta que tenga éxito. Esto es útil si una configuración local es conocida bajo

diferentes nombres en diferentes sistemas o para proporcionar una alternativa

para una configuración local posiblemente no disponible.

</para>

</listitem>

</varlistentry>

</variablelist>

<note>

<para>

En Windows, setlocale(LC_ALL, '') establece los nombres de configuración local a partir de

la configuración regional/idioma del sistema (accesible a través del Panel de Control).

</para>

</note>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve la nueva configuración local actual, o &false; si la funcionalidad de configuración local no está

implementada en su plataforma, la configuración local especificada no existe o

el nombre de la categoría no es válido.

</para>

<para>

Un nombre de categoría no válido también causa un mensaje de advertencia. Los nombres de categoría/configuración local

se pueden encontrar en <link xlink:href="&url.rfc;1766">RFC 1766</link>

y <link xlink:href="&url.iso-639;">ISO 639</link>.

Diferentes sistemas tienen diferentes esquemas de nombres para configuraciones locales.

</para>

<note>

<para>

El valor de retorno de <function>setlocale</function> depende

del sistema en el que se está ejecutando PHP. Devuelve exactamente

lo que devuelve la función <literal>setlocale</literal> del sistema.

</para>

</note>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.5.0</entry>

<entry>

Pasar un entero <literal>0</literal> como argumento

<parameter>locales</parameter> ya no está soportado y

ahora lanza un <classname>TypeError</classname>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplos de <function>setlocale</function></title>

<programlisting role="php" annotations="non-interactive">

<![CDATA[

<?php

/* Establecer configuración local a holandés */

setlocale(LC_ALL, 'nl_NL');

/* Salida: vrijdag 22 december 1978 */

echo strftime("%A %e %B %Y", mktime(0, 0, 0, 12, 22, 1978));

/* probar diferentes nombres posibles de configuración local para alemán */

$loc_de = setlocale(LC_ALL, 'de_DE@euro', 'de_DE', 'de', 'ge');

echo "Configuración local preferida para alemán en este sistema es '$loc_de'";

?>

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title>Recuperar la configuración actual de <function>setlocale</function></title>

<programlisting role="php" annotations="non-interactive">

<![CDATA[

<?php

/* Recuperar la configuración actual */

$current = setlocale(LC_ALL, null);

echo "Configuración local actual '$current'";

?>

]]>

</programlisting>

</example>

</para>

<para>

<example>

<title>Ejemplos de <function>setlocale</function> para Windows</title>

<programlisting role="php" annotations="non-interactive">

<![CDATA[

<?php

/* Establecer configuración local a holandés */

setlocale(LC_ALL, 'nld_nld');

/* Salida: vrijdag 22 december 1978 */

echo strftime("%A %d %B %Y", mktime(0, 0, 0, 12, 22, 1978));

/* probar diferentes nombres posibles de configuración local para alemán */

$loc_de = setlocale(LC_ALL, 'de_DE@euro', 'de_DE', 'deu_deu');

echo "Configuración local preferida para alemán en este sistema es '$loc_de'";

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<tip>

<para>

Los usuarios de Windows encontrarán información útil sobre

las cadenas <parameter>locales</parameter> en el sitio web de

<acronym>MSDN</acronym> de Microsoft. Las cadenas de idioma soportadas se pueden encontrar en la

<link xlink:href="&url.setlocale.lang.win32;">documentación de cadenas de idioma</link>

y las cadenas de país/región soportadas en la

<link xlink:href="&url.setlocale.country.win32;">documentación de cadenas de país/región</link>.

</para>

</tip>

</refsect1>

</refentry>

<!-- Keep this comment at the end of the file

Local variables:

mode: sgml

sgml-omittag:t

sgml-shorttag:t

sgml-minimize-attributes:nil

sgml-always-quote-attributes:t

sgml-indent-step:1

sgml-indent-data:t

indent-tabs-mode:nil

sgml-parent-document:nil

sgml-default-dtd-file:"~/.phpdoc/manual.ced"

sgml-exposed-tags:nil

sgml-local-catalogs:nil

sgml-local-ecat-files:nil

End:

vim600: syn=xml fen fdm=syntax fdl=2 si

vim: et tw=78 syn=sgml

vi: ts=1 sw=1

-->