php-doc-en/reference/intl/locale/set-default.xml
Jakub Vrana 7418592d82 Capitalize <refpurpose>
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343887 c90b9560-bf6c-de11-be94-00142212c4b1
2018-01-25 15:24:28 +00:00

120 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="locale.setdefault">
<refnamediv>
<refname>Locale::setDefault</refname>
<refname>locale_set_default</refname>
<refpurpose>Sets the default runtime locale</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>bool</type>
<methodname>Locale::setDefault</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>bool</type>
<methodname>locale_set_default</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
</methodsynopsis>
<para>
Sets the default runtime locale to $locale. This changes the value of INTL
global 'default_locale' locale identifier. UAX #35 extensions are accepted.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<para>
Is a BCP 47 compliant language tag.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>locale_set_default</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
locale_set_default('de-DE');
echo locale_get_default();
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
<?php
Locale::setDefault('de-DE');
echo Locale::getDefault();
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
de-DE
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>locale_get_default</function></member>
</simplelist>
</para>
</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
-->