Files
doc-fr/reference/intl/locale/get-display-script.xml
George Peter Banyard 624d3a299c Apply 6fcf444471febbbc7ad0a52f16303f6957362447
Generate ext/intl methodsynopses based on stubs (Locale)

Weirdly part of it was propagated in the revcheck script with the incorrect hash as to recent
2021-09-06 02:23:47 +01:00

163 lines
4.5 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6fcf444471febbbc7ad0a52f16303f6957362447 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="locale.getdisplayscript" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Locale::getDisplayScript</refname>
<refname>locale_get_display_script</refname>
<refpurpose>Retourne le nom du script de la locale</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis role="oop">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Locale::getDisplayScript</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>displayLocale</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis role="procedural">
<type class="union"><type>string</type><type>false</type></type><methodname>locale_get_display_script</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>displayLocale</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Retourne le nom du script de la locale.
Si &null; est passé, la locale par défaut est utilisée.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<para>
La locale dont il faut retourner le script.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>displayLocale</parameter></term>
<listitem>
<para>
Un format optionnel pour afficher le nom du script.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Affiche le nom du script de la <parameter>locale</parameter> au format indiqué par
<parameter>displayLocale</parameter>, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>displayLocale</parameter> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Exemple avec <function>locale_get_display_script</function>, procédural</title>
<programlisting role="php">
<![CDATA[
<?php
echo locale_get_display_script('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo locale_get_display_script('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo locale_get_display_script('sl-Latn-IT-nedis', 'de');
?>
]]>
</programlisting>
</example>
<example>
<title>Exemple avec <function>locale_get_display_script</function>, POO</title>
<programlisting role="php">
<![CDATA[
<?php
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'en');
echo ";\n";
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'fr');
echo ";\n";
echo Locale::getDisplayScript('sl-Latn-IT-nedis', 'de');
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Latin;
latin;
Lateinisch
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>locale_get_display_name</function></member>
<member><function>locale_get_display_language</function></member>
<member><function>locale_get_display_region</function></member>
<member><function>locale_get_display_variant</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
-->