<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Defines a set of constants for retrieval and mass-definition</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.apc-dec.html">apc_dec</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.apc-delete-file.html">apc_delete_file</a></div> <div class="up"><a href="ref.apc.html">APC Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.apc-define-constants" class="refentry"> <div class="refnamediv"> <h1 class="refname">apc_define_constants</h1> <p class="verinfo">(PECL apc >= 3.0.0)</p><p class="refpurpose"><span class="refname">apc_define_constants</span> — <span class="dc-title"> Defines a set of constants for retrieval and mass-definition </span></p> </div> <div class="refsect1 description" id="refsect1-function.apc-define-constants-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>apc_define_constants</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$constants</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$case_sensitive</code><span class="initializer"> = true</span></span> ] )</div> <p class="para rdfs-comment"> <span class="function"><a href="function.define.html" class="function">define()</a></span> is notoriously slow. Since the main benefit of APC is to increase the performance of scripts/applications, this mechanism is provided to streamline the process of mass constant definition. However, this function does not perform as well as anticipated. </p> <p class="para"> For a better-performing solution, try the <a href="http://pecl.php.net/package/hidef" class="link external">» hidef</a> extension from PECL. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> To remove a set of stored constants (without clearing the entire cache), an empty array may be passed as the <em><code class="parameter">constants</code></em> parameter, effectively clearing the stored value(s). </span> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.apc-define-constants-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">key</code></em></span> <dd> <p class="para"> The <em><code class="parameter">key</code></em> serves as the name of the constant set being stored. This <em><code class="parameter">key</code></em> is used to retrieve the stored constants in <span class="function"><a href="function.apc-load-constants.html" class="function">apc_load_constants()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">constants</code></em></span> <dd> <p class="para"> An associative array of <em>constant_name => value</em> pairs. The <em>constant_name</em> must follow the normal <a href="language.constants.html" class="link">constant</a> naming rules. <em>value</em> must evaluate to a scalar value. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">case_sensitive</code></em></span> <dd> <p class="para"> The default behaviour for constants is to be declared case-sensitive; i.e. <em>CONSTANT</em> and <em>Constant</em> represent different values. If this parameter evaluates to <strong><code>FALSE</code></strong> the constants will be declared as case-insensitive symbols. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.apc-define-constants-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.apc-define-constants-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-409"> <p><strong>Example #1 <span class="function"><strong>apc_define_constants()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$constants </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'ONE' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'TWO' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'THREE' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">,<br />);<br /></span><span style="color: #0000BB">apc_define_constants</span><span style="color: #007700">(</span><span style="color: #DD0000">'numbers'</span><span style="color: #007700">, </span><span style="color: #0000BB">$constants</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">ONE</span><span style="color: #007700">, </span><span style="color: #0000BB">TWO</span><span style="color: #007700">, </span><span style="color: #0000BB">THREE</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> 123 </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.apc-define-constants-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.apc-load-constants.html" class="function" rel="rdfs-seeAlso">apc_load_constants()</a> - Loads a set of constants from the cache</span></li> <li class="member"> <span class="function"><a href="function.define.html" class="function" rel="rdfs-seeAlso">define()</a> - Defines a named constant</span></li> <li class="member"> <span class="function"><a href="function.constant.html" class="function" rel="rdfs-seeAlso">constant()</a> - Returns the value of a constant</span></li> <li class="member"> Or <a href="language.constants.html" class="link">the PHP constants reference</a> </li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.apc-dec.html">apc_dec</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.apc-delete-file.html">apc_delete_file</a></div> <div class="up"><a href="ref.apc.html">APC Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>