<!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>This factory method creates a hash from a file</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="quickhashinthash.getsize.html">QuickHashIntHash::getSize</a></div> <div class="next" style="text-align: right; float: right;"><a href="quickhashinthash.loadfromstring.html">QuickHashIntHash::loadFromString</a></div> <div class="up"><a href="class.quickhashinthash.html">QuickHashIntHash</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="quickhashinthash.loadfromfile" class="refentry"> <div class="refnamediv"> <h1 class="refname">QuickHashIntHash::loadFromFile</h1> <p class="verinfo">(PECL quickhash >= Unknown)</p><p class="refpurpose"><span class="refname">QuickHashIntHash::loadFromFile</span> — <span class="dc-title">This factory method creates a hash from a file</span></p> </div> <div class="refsect1 description" id="refsect1-quickhashinthash.loadfromfile-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type"><a href="class.quickhashinthash.html" class="type QuickHashIntHash">QuickHashIntHash</a></span> <span class="methodname"><strong>QuickHashIntHash::loadFromFile</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code></span> ] )</div> <p class="para rdfs-comment"> This factory method creates a new hash from a definition file on disk. The file format consists of a signature 'QH\0x11\0', the number of elements as a 32 bit signed integer in system Endianness, followed by 32 bit signed integers packed together in the Endianness that the system that the code runs on uses. For each hash element there are two 32 bit signed integers stored. The first of each element is the key, and the second is the value belonging to the key. An example could be: </p> <p class="para"> <div class="example" id="example-5144"> <p><strong>Example #1 QuickHash IntHash file format</strong></p> <div class="example-contents screen"><div class="descriptioncode"><pre class="descriptioncode">00000000 51 48 11 00 02 00 00 00 01 00 00 00 01 00 00 00 |QH..............| 00000010 03 00 00 00 09 00 00 00 |........| 00000018</pre> </div></div> </div> </p> <p class="para"> <div class="example" id="example-5145"> <p><strong>Example #2 QuickHash IntHash file format</strong></p> <div class="example-contents screen"><div class="descriptioncode"><pre class="descriptioncode">header signature ('QH'; key type: 1; value type: 1; filler: \0x00) 00000000 51 48 11 00 number of elements: 00000004 02 00 00 00 data string: 00000000 01 00 00 00 01 00 00 00 03 00 00 00 09 00 00 00 key/value 1 (key = 1, value = 1) 01 00 00 00 01 00 00 00 key/value 2 (key = 3, value = 9) 03 00 00 00 09 00 00 00</pre> </div></div> </div> </p> </div> <div class="refsect1 parameters" id="refsect1-quickhashinthash.loadfromfile-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">filename</code></em></span> <dd> <p class="para"> The filename of the file to read the hash from. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">options</code></em></span> <dd> <p class="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. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-quickhashinthash.loadfromfile-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a new QuickHashIntHash. </p> </div> <div class="refsect1 examples" id="refsect1-quickhashinthash.loadfromfile-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-5146"> <p><strong>Example #3 <span class="function"><strong>QuickHashIntHash::loadFromFile()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= </span><span style="color: #0000BB">dirname</span><span style="color: #007700">( </span><span style="color: #0000BB">__FILE__ </span><span style="color: #007700">) . </span><span style="color: #DD0000">"/simple.hash"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">QuickHashIntHash</span><span style="color: #007700">::</span><span style="color: #0000BB">loadFromFile</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$file</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">QuickHashIntHash</span><span style="color: #007700">::</span><span style="color: #0000BB">DO_NOT_USE_ZEND_ALLOC<br /></span><span style="color: #007700">);<br />foreach( </span><span style="color: #0000BB">range</span><span style="color: #007700">( </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0x0f </span><span style="color: #007700">) as </span><span style="color: #0000BB">$key </span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">( </span><span style="color: #DD0000">"Key %3d (%2x) is %s\n"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$key</span><span style="color: #007700">, </span><span style="color: #0000BB">$key</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">$hash</span><span style="color: #007700">-></span><span style="color: #0000BB">exists</span><span style="color: #007700">( </span><span style="color: #0000BB">$key </span><span style="color: #007700">) ? </span><span style="color: #DD0000">'set' </span><span style="color: #007700">: </span><span style="color: #DD0000">'unset'<br /> </span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> Key 0 ( 0) is unset Key 1 ( 1) is set Key 2 ( 2) is set Key 3 ( 3) is set Key 4 ( 4) is unset Key 5 ( 5) is set Key 6 ( 6) is unset Key 7 ( 7) is set Key 8 ( 8) is unset Key 9 ( 9) is unset Key 10 ( a) is unset Key 11 ( b) is set Key 12 ( c) is unset Key 13 ( d) is set Key 14 ( e) is unset Key 15 ( f) is unset </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="quickhashinthash.getsize.html">QuickHashIntHash::getSize</a></div> <div class="next" style="text-align: right; float: right;"><a href="quickhashinthash.loadfromstring.html">QuickHashIntHash::loadFromString</a></div> <div class="up"><a href="class.quickhashinthash.html">QuickHashIntHash</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>