<!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>File threading</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pht-thread.addClassTask.html">pht\Thread::addClassTask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-thread.addFunctionTask.html">pht\Thread::addFunctionTask</a></div>
<div class="up"><a href="class.pht-thread.html">pht\Thread</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pht-thread.addFileTask" class="refentry">
<div class="refnamediv">
<h1 class="refname">pht\Thread::addFileTask</h1>
<p class="verinfo">(PECL pht >= 0.0.1)</p><p class="refpurpose"><span class="refname">pht\Thread::addFileTask</span> — <span class="dc-title">File threading</span></p>
</div>
<div class="refsect1 description" id="refsect1-pht-thread.addFileTask-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>pht\Thread::addFileTask</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$fileName</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...globals</code></span>
] )</div>
<p class="para rdfs-comment">
Adds a new file task to a <a href="class.pht-thread.html" class="classname">pht\Thread</a>s internal task queue.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-pht-thread.addFileTask-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">func</code></dt>
<dd>
<p class="para">
The name of the file to be threaded.
</p>
</dd>
<dt>
<code class="parameter">...globals</code></dt>
<dd>
<p class="para">
An optional list of arguments for the file. These arguments will be
placed into a <em>$_THREAD</em> superglobal, which will be made
available inside of the threaded file. All arguments will be serialised
(since they are being passed to another thread).
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-pht-thread.addFileTask-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No return value.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pht-thread.addFileTask-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4547">
<p><strong>Example #1 Adding a new file task to a thread</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">use </span><span style="color: #0000BB">pht</span><span style="color: #007700">\</span><span style="color: #0000BB">Thread</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$thread </span><span style="color: #007700">= new </span><span style="color: #0000BB">Thread</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">addFileTask</span><span style="color: #007700">(</span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">start</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$thread</span><span style="color: #007700">-></span><span style="color: #0000BB">join</span><span style="color: #007700">();</span>
</span>
</code></div>
</div>
<div class="example-contents"><p>file.php:</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">[</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">] = </span><span style="color: #0000BB">$_THREAD</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</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">);</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>
int(1)
int(2)
int(3)
</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="pht-thread.addClassTask.html">pht\Thread::addClassTask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pht-thread.addFunctionTask.html">pht\Thread::addFunctionTask</a></div>
<div class="up"><a href="class.pht-thread.html">pht\Thread</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
