Source of: /manual/en/internals2.counter.constants.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/internals2.counter.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'internals2.counter.constants.php',
1 => 'Predefined Constants',
),
'up' =>
array (
0 => 'internals2.counter.php',
1 => 'The "counter" Extension - A Continuing Example',
),
'prev' =>
array (
0 => 'internals2.counter.resources.php',
1 => 'Resource Types',
),
'next' =>
array (
0 => 'internals2.counter.examples.php',
1 => 'Examples',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div>
<h1>Predefined Constants</h1>
<p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
<dl>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_FLAG_PERSIST</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
A counter with this flag will be created as a persistent resource.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_FLAG_SAVE</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
A counter with this flag will be saved between invocations of PHP.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_FLAG_NO_OVERWRITE</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
This flag causes <a href="internals2.counter.function.counter-create.php" class="function">counter_create()</a> to avoid overwriting
an existing named counter with a new one.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_META_NAME</tt></b>
(<a href="language.types.string.php" class="type string">string</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
Pass this constant to get the name of a counter resource or object.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_META_IS_PERISTENT</tt></b>
(<a href="language.types.string.php" class="type string">string</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
Pass this constant to determine whether a counter resource or object is
persistent (has the <b><tt class="constant">COUNTER_FLAG_PERSIST</tt></b> flag).
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_RESET_NEVER</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
The counter will never be reset.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_RESET_PER_LOAD</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
The counter will be reset on each invocation of PHP.
</span>
</dd>
<dt class="varlistentry">
<span class="term">
<b><tt class="constant">COUNTER_RESET_PER_REQUEST</tt></b>
(<a href="language.types.integer.php" class="type integer">integer</a>)
</span>
</dt><dd class="listitem">
<span class="simpara">
The counter will be reset on each request.
</span>
</dd>
</dl>
</div>
<?php manual_footer(); ?>
