<!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>Provide a return value for an existing function</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.uopz-set-property.html">uopz_set_property</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.uopz-set-static.html">uopz_set_static</a></div>
<div class="up"><a href="ref.uopz.html">Uopz Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.uopz-set-return" class="refentry">
<div class="refnamediv">
<h1 class="refname">uopz_set_return</h1>
<p class="verinfo">(PECL uopz 5)</p><p class="refpurpose"><span class="refname">uopz_set_return</span> — <span class="dc-title">Provide a return value for an existing function</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.uopz-set-return-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>uopz_set_return</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$function</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">$value</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$execute</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>uopz_set_return</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$class</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$function</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">$value</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$execute</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
] )</div>
<p class="para rdfs-comment">
Sets the return value of the <code class="parameter">function</code> to <code class="parameter">value</code>. If <code class="parameter">value</code>
is a Closure and <code class="parameter">execute</code> is set, the Closure will be executed in place of the original function.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function replaces <span class="methodname"><a href="function.uopz-rename.html" class="methodname">uopz_rename()</a></span>.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.uopz-set-return-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">class</code></dt>
<dd>
<p class="para">
The name of the class containing the function
</p>
</dd>
<dt>
<code class="parameter">function</code></dt>
<dd>
<p class="para">
The name of an existing function
</p>
</dd>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
The value the function should return. If a Closure is provided and the execute flag is set, the Closure will be executed in place of the original function.
</p>
</dd>
<dt>
<code class="parameter">execute</code></dt>
<dd>
<p class="para">
If true, and a Closure was provided as the value, the Closure will be executed in place of the original function.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.uopz-set-return-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
True if succeeded, false otherwise.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.uopz-set-return-examples">
<h3 class="title">Examples</h3>
<div class="example" id="uopz-get-hook.example.basic">
<p><strong>Example #1 <span class="function"><strong>uopz_set_return()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />uopz_set_return</span><span style="color: #007700">(</span><span style="color: #DD0000">"strlen"</span><span style="color: #007700">, </span><span style="color: #0000BB">42</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #DD0000">"Banana"</span><span style="color: #007700">);<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>
42
</pre></div>
</div>
</div>
<div class="example" id="example-624">
<p><strong>Example #2 <span class="function"><strong>uopz_set_return()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />uopz_set_return</span><span style="color: #007700">(</span><span style="color: #DD0000">"strlen"</span><span style="color: #007700">, function(</span><span style="color: #0000BB">$str</span><span style="color: #007700">) { return </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">) * </span><span style="color: #0000BB">2</span><span style="color: #007700">; }, </span><span style="color: #0000BB">true </span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #DD0000">"Banana"</span><span style="color: #007700">);<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>
12
</pre></div>
</div>
</div>
<div class="example" id="uopz-get-property.example.basic">
<p><strong>Example #3 <span class="function"><strong>uopz_set_return()</strong></span> class example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">My </span><span style="color: #007700">{<br /> public static function </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$arg</span><span style="color: #007700">) {<br /> return </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$arg</span><span style="color: #007700">);<br /> }<br />}<br /></span><span style="color: #0000BB">uopz_set_return</span><span style="color: #007700">(</span><span style="color: #0000BB">My</span><span style="color: #007700">::class, </span><span style="color: #DD0000">"strlen"</span><span style="color: #007700">, function(</span><span style="color: #0000BB">$str</span><span style="color: #007700">) { return </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">) * </span><span style="color: #0000BB">2</span><span style="color: #007700">; }, </span><span style="color: #0000BB">true </span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">My</span><span style="color: #007700">::</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #DD0000">"Banana"</span><span style="color: #007700">);<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>
12
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.uopz-set-property.html">uopz_set_property</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.uopz-set-static.html">uopz_set_static</a></div>
<div class="up"><a href="ref.uopz.html">Uopz Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
