php-doc-en/reference/apc/functions/apc-load-constants.xml
Jakub Vrana a85177802b Fix parameters
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@193986 c90b9560-bf6c-de11-be94-00142212c4b1
2005-08-19 15:11:25 +00:00

116 lines
2.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.apc-load-constants">
<refnamediv>
<refname>apc_load_constants</refname>
<refpurpose>
Loads a set of constants from the cache
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>apc_load_constants</methodname>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>case_sensitive</parameter></methodparam>
</methodsynopsis>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
The name of the constant set (that was stored with
<function>apc_define_constants</function>) to be retrieved.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>case_sensitive</parameter></term>
<listitem>
<para>
The default behaviour for constants is to be declared case-sensitive;
i.e. <literal>CONSTANT</literal> and <literal>Constant</literal>
represent different values. If this parameter evaluates to &false; the
constants will be declared as case-insensitive symbols.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>apc_load_constants</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$constants = array(
'ONE' => 1,
'TWO' => 2,
'THREE' => 3,
);
apc_define_constants('numbers', $constants);
apc_load_constants('numbers');
echo ONE, TWO, THREE;
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
123
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>apc_define_constants</function></member>
<member><function>define</function></member>
<member><function>constant</function></member>
<member>
Or <link linkend="language.constants">the PHP constants reference</link>
</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
-->