File: create.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (145 lines) | stat: -rw-r--r-- 4,595 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="resourcebundle.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ResourceBundle::create</refname>
  <refname>resourcebundle_create</refname>
  <refname>ResourceBundle::__construct</refname>
  <refpurpose>Create a resource bundle</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop; (method)
  </para>
  <methodsynopsis role="ResourceBundle">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>ResourceBundle</type><type>null</type></type><methodname>ResourceBundle::create</methodname>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>locale</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>bundle</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>ResourceBundle</type><type>null</type></type><methodname>resourcebundle_create</methodname>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>locale</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>bundle</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.oop; (constructor):
  </para>
   <constructorsynopsis role="ResourceBundle">
   <modifier>public</modifier> <methodname>ResourceBundle::__construct</methodname>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>locale</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>bundle</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>fallback</parameter><initializer>&true;</initializer></methodparam>
  </constructorsynopsis>
  <para>
   Creates a resource bundle.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       Locale for which the resources should be loaded (locale name, e.g. en_CA).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bundle</parameter></term>
     <listitem>
      <para>
       The directory where the data is stored or the name of the .dat file.
      </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 <classname>ResourceBundle</classname> object or &null; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>resourcebundle_create</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$r = resourcebundle_create( 'es', "/usr/share/data/myapp");
echo $r['teststring'];
?>
]]>
   </programlisting>
  </example>
  <example>
   <title><function>ResourceBundle::create</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$r = ResourceBundle::create( 'es', "/usr/share/data/myapp");
echo $r['teststring'];
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
¡Hola, mundo!
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>resourcebundle_get</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
-->