php-doc-en/reference/intl/resourcebundle/create.xml
Peter Cowburn 34dc39d9a0 Return type null on error
Patch by anonymous 

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333670 c90b9560-bf6c-de11-be94-00142212c4b1
2014-06-01 13:12:55 +00:00

151 lines
4 KiB
XML

<?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>
<modifier>public</modifier>
<modifier>static</modifier>
<type>ResourceBundle</type>
<methodname>ResourceBundle::create</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>string</type><parameter>bundlename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>fallback</parameter></methodparam>
</methodsynopsis>
<para>
&style.procedural;
</para>
<methodsynopsis>
<type>ResourceBundle</type>
<methodname>resourcebundle_create</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>string</type><parameter>bundlename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>fallback</parameter></methodparam>
</methodsynopsis>
<para>
&style.oop; (constructor):
</para>
<constructorsynopsis>
<modifier>public</modifier>
<methodname>ResourceBundle::__construct</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>string</type><parameter>bundlename</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>fallback</parameter></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>bundlename</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
-->