mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 17:02:07 +01:00
bfa171ecb7
Just today, quickhash 1.1.1 has been released, bringing support for PHP
7, so we restore the docs.
This reverts commit a6ce8d349d.
138 lines
3.6 KiB
XML
138 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="quickhashstringinthash.loadfromstring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>QuickHashStringIntHash::loadFromString</refname>
|
|
<refpurpose>This factory method creates a hash from a string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>QuickHashStringIntHash</type><methodname>QuickHashStringIntHash::loadFromString</methodname>
|
|
<methodparam><type>string</type><parameter>contents</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This factory method creates a new hash from a definition in a string. The
|
|
format is the same as the one used in "loadFromFile".
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>contents</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string containing a serialized format of the hash.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>size</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The amount of bucket lists to configure. The number you pass in will be
|
|
automatically rounded up to the next power of two. It is also
|
|
automatically limited from 4 to 4194304.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The same options that the class' constructor takes; except that the size
|
|
option is ignored. It is automatically calculated to be the same as the
|
|
number of entries in the hash, rounded up to the nearest power of two
|
|
with a maximum limit of 4194304.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a new QuickHashStringIntHash.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>QuickHashStringIntHash::loadFromString</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$contents = file_get_contents( dirname( __FILE__ ) . "/simple.hash.string" );
|
|
$hash = QuickHashStringIntHash::loadFromString(
|
|
$contents,
|
|
QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC
|
|
);
|
|
foreach( range( 0, 0x0f ) as $key )
|
|
{
|
|
$i = 48712 + $key * 1631;
|
|
$k = base_convert( $i, 10, 36 );
|
|
echo $k, ' => ', $hash->get( $k ), "\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
11l4 => 48712
|
|
12uf => 50343
|
|
143q => 51974
|
|
15d1 => 53605
|
|
16mc => 55236
|
|
17vn => 56867
|
|
194y => 58498
|
|
1ae9 => 60129
|
|
1bnk => 61760
|
|
1cwv => 63391
|
|
1e66 => 65022
|
|
1ffh => 66653
|
|
1gos => 68284
|
|
1hy3 => 69915
|
|
1j7e => 71546
|
|
1kgp => 73177
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|