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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="resourcebundle.get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ResourceBundle::get</refname>
<refname>resourcebundle_get</refname>
<refpurpose>Get data from the bundle</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
&style.oop;
</para>
<methodsynopsis role="ResourceBundle">
<modifier>public</modifier> <type>mixed</type><methodname>ResourceBundle::get</methodname>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>mixed</type><methodname>resourcebundle_get</methodname>
<methodparam><type>ResourceBundle</type><parameter>bundle</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>int</type></type><parameter>index</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
</methodsynopsis>
<para>
Get the data from the bundle by index or string key.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>bundle</parameter></term>
<listitem>
<para>
<classname>ResourceBundle</classname> object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
Data index, must be string or integer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>fallback</parameter></term>
<listitem>
<para>
Whether locale should match exactly or fallback to parent locale is allowed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the data located at the index or &null; on error. Strings, integers and binary data strings
are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are
returned as <classname>ResourceBundle</classname> object.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
A <exceptionname>TypeError</exceptionname> is thrown if
the offset type is invalid.
</simpara>
<simpara>
A <exceptionname>ValueError</exceptionname> is thrown if
if <parameter>index</parameter> is a <type>string</type>
and is empty or is a <type>int</type> and does not
fit into a 32 bit integer type.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
<simpara>
A <exceptionname>TypeError</exceptionname> is thrown if
the offset type is invalid.
A <exceptionname>ValueError</exceptionname> is thrown if
if <parameter>index</parameter> is a <type>string</type>
and is empty or is a <type>int</type> and does not
fit into a 32 bit integer type.
</simpara>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>resourcebundle_get</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$r = resourcebundle_create( 'es', "/usr/share/data/myapp");
echo resourcebundle_get($r, 'somestring');
?>
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
<?php
$r = new ResourceBundle( 'es', "/usr/share/data/myapp");
echo $r->get('somestring');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
?Hola, mundo!
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>resourcebundle_count</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
-->
|
