php-doc-en/reference/quickhash/quickhashstringinthash.xml
2012-01-03 07:06:01 +00:00

115 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.quickhashstringinthash" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The QuickHashStringIntHash class</title>
<titleabbrev>QuickHashStringIntHash</titleabbrev>
<partintro>
<!-- {{{ QuickHashStringIntHash intro -->
<section xml:id="quickhashstringinthash.intro">
&reftitle.intro;
<para>
This class wraps around a hash containing strings, where the
values are integer numbers. Hashes are also available as
implementation of the ArrayAccess interface.
</para>
<para>
Hashes can also be iterated over with foreach as the Iterator interface is
implemented as well. The order of which elements are returned in is not
guaranteed.
</para>
</section>
<!-- }}} -->
<section xml:id="quickhashstringinthash.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>QuickHashStringIntHash</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>QuickHashStringIntHash</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="quickhashstringinthash.constants.check-for-dupes">QuickHashStringIntHash::CHECK_FOR_DUPES</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="quickhashstringinthash.constants.do-not-use-zend-alloc">QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</varname>
<initializer>2</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.quickhashstringinthash')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ QuickHashStringIntHash constants -->
<section xml:id="quickhashstringinthash.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="quickhashstringinthash.constants.check-for-dupes">
<term><constant>QuickHashStringIntHash::CHECK_FOR_DUPES</constant></term>
<listitem>
<para>If enabled, adding duplicate elements to a set (through either add() or
loadFromFile()) will result in those elements to be dropped from the
set. This will take up extra time, so only used when it is required.</para>
</listitem>
</varlistentry>
<varlistentry xml:id="quickhashstringinthash.constants.do-not-use-zend-alloc">
<term><constant>QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</constant></term>
<listitem>
<para>Disables the use of PHP's internal memory manager for internal
set structures. With this option enabled, internal allocations will not
count towards the memory_limit settings.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.quickhash.entities.quickhashstringinthash;
</phpdoc:classref>
<!-- 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
-->