1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="locale.composelocale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Locale::composeLocale</refname>
<refname>locale_compose_locale</refname>
<refpurpose>Returns a correctly ordered and delimited locale ID</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Object oriented style
</para>
<methodsynopsis>
<modifier>static</modifier>
<type>string</type>
<methodname>Locale::composeLocale</methodname>
<methodparam><type>array</type><parameter>subtags</parameter></methodparam>
</methodsynopsis>
<para>
Procedural style
</para>
<methodsynopsis>
<type>string</type>
<methodname>locale_compose</methodname>
<methodparam><type>array</type><parameter>subtags</parameter></methodparam>
</methodsynopsis>
<para>
Returns a correctly ordered and delimited locale ID the keys identify the
particular locale ID subtags, and the values are the associated subtag
values.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>subtags</parameter></term>
<listitem>
<para>
an array containing a list of key-value pairs, where the keys identify
the particular locale ID subtags, and the values are the associated
subtag values.
<note>
<para>
The 'variant' and 'private' subtags can take maximum 15 values
whereas 'extlang' can take maximum 3 values.e.g. Variants are allowed
with the suffix ranging from 0-14. Hence the keys for the input array
can be variant0, variant1, ...,variant14. In the returned locale id,
the subtag is ordered by suffix resulting in variant0 followed by
variant1 followed by variant2 and so on.
</para>
<para>
The 'variant', 'private' and 'extlang' multiple values can be specified both
as array under specific key (e.g. 'variant') and as multiple numbered keys
(e.g. 'variant0', 'variant1', etc.).
</para>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The corresponding locale identifier.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>locale_compose</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$arr = array(
'language'=>'en' ,
'script' =>'Hans' ,
'region' =>'CN',
'variant2'=>'rozaj' ,
'variant1'=>'nedis' ,
'private1'=>'prv1' ,
'private2'=>'prv2'
);
echo locale_compose( $arr );
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
<?php
$arr = array(
'language'=>'en' ,
'script' =>'Hans' ,
'region' =>'CN',
'variant2'=>'rozaj' ,
'variant1'=>'nedis' ,
'private1'=>'prv1' ,
'private2'=>'prv2'
);
echo Locale::composeLocale( $arr );
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Locale: en_Hans_CN_nedis_rozaj_x_prv1_prv2
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>locale_parse</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:"../../../../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
-->
|
