<!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>Register a URL wrapper implemented as a PHP class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-supports-lock.html">stream_supports_lock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-wrapper-restore.html">stream_wrapper_restore</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.stream-wrapper-register" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_wrapper_register</h1>
<p class="verinfo">(PHP 4 >= 4.3.2, PHP 5)</p><p class="refpurpose"><span class="refname">stream_wrapper_register</span> — <span class="dc-title">Register a URL wrapper implemented as a PHP class</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-wrapper-register-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>stream_wrapper_register</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$protocol</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$classname</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code> <span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Allows you to implement your own protocol handlers and streams for use
with all the other filesystem functions (such as <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span>,
<span class="function"><a href="function.fread.html" class="function">fread()</a></span> etc.).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-wrapper-register-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">protocol</code></em></span>
<dd>
<p class="para">
The wrapper name to be registered.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">classname</code></em></span>
<dd>
<p class="para">
The classname which implements the <em><code class="parameter">protocol</code></em>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Should be set to <strong><code>STREAM_IS_URL</code></strong> if
<em><code class="parameter">protocol</code></em> is a URL protocol. Default is 0, local
stream.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-wrapper-register-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
<p class="para">
<span class="function"><strong>stream_wrapper_register()</strong></span> will return <strong><code>FALSE</code></strong> if the
<em><code class="parameter">protocol</code></em> already has a handler.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.stream-wrapper-register-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.2.4</td>
<td>
Added the <em><code class="parameter">flags</code></em> parameter.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-wrapper-register-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4042">
<p><strong>Example #1 How to register a stream wrapper</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$existed </span><span style="color: #007700">= </span><span style="color: #0000BB">in_array</span><span style="color: #007700">(</span><span style="color: #DD0000">"var"</span><span style="color: #007700">, </span><span style="color: #0000BB">stream_get_wrappers</span><span style="color: #007700">());<br />if (</span><span style="color: #0000BB">$existed</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">stream_wrapper_unregister</span><span style="color: #007700">(</span><span style="color: #DD0000">"var"</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">stream_wrapper_register</span><span style="color: #007700">(</span><span style="color: #DD0000">"var"</span><span style="color: #007700">, </span><span style="color: #DD0000">"VariableStream"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$myvar </span><span style="color: #007700">= </span><span style="color: #DD0000">""</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"var://myvar"</span><span style="color: #007700">, </span><span style="color: #DD0000">"r+"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"line1\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"line2\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"line3\n"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">rewind</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br />while (!</span><span style="color: #0000BB">feof</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$myvar</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$existed</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">stream_wrapper_restore</span><span style="color: #007700">(</span><span style="color: #DD0000">"var"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></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>
line1
line2
line3
string(18) "line1
line2
line3
"
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-wrapper-register-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member">The <a href="class.streamwrapper.html" class="xref">streamWrapper</a> prototype class</li>
<li class="member"><a href="stream.streamwrapper.example-1.html" class="xref">Example class registered as stream wrapper</a></li>
<li class="member"> <span class="function"><a href="function.stream-wrapper-unregister.html" class="function" rel="rdfs-seeAlso">stream_wrapper_unregister()</a> - Unregister a URL wrapper</span></li>
<li class="member"> <span class="function"><a href="function.stream-wrapper-restore.html" class="function" rel="rdfs-seeAlso">stream_wrapper_restore()</a> - Restores a previously unregistered built-in wrapper</span></li>
<li class="member"> <span class="function"><a href="function.stream-get-wrappers.html" class="function" rel="rdfs-seeAlso">stream_get_wrappers()</a> - Retrieve list of registered streams</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-supports-lock.html">stream_supports_lock</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-wrapper-restore.html">stream_wrapper_restore</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
