<!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>Dynamically changes the code of the given method</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.runkit-method-copy.html">runkit_method_copy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.runkit-method-remove.html">runkit_method_remove</a></div>
<div class="up"><a href="ref.runkit.html">runkit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.runkit-method-redefine" class="refentry">
<div class="refnamediv">
<h1 class="refname">runkit_method_redefine</h1>
<p class="verinfo">(PECL runkit >= 0.7.0)</p><p class="refpurpose"><span class="refname">runkit_method_redefine</span> — <span class="dc-title">Dynamically changes the code of the given method</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.runkit-method-redefine-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>runkit_method_redefine</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$classname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$methodname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$args</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$code</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = RUNKIT_ACC_PUBLIC</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$doc_comment</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>runkit_method_redefine</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$classname</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$methodname</code></span>
, <span class="methodparam"><span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <code class="parameter">$closure</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = RUNKIT_ACC_PUBLIC</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$doc_comment</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
]] )</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function cannot
be used to manipulate the currently running (or chained) method.</span>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-function.runkit-method-redefine-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">classname</code></dt>
<dd>
<p class="para">
The class in which to redefine the method
</p>
</dd>
<dt>
<code class="parameter">methodname</code></dt>
<dd>
<p class="para">
The name of the method to redefine
</p>
</dd>
<dt>
<code class="parameter">args</code></dt>
<dd>
<p class="para">
Comma-delimited list of arguments for the redefined method
</p>
</dd>
<dt>
<code class="parameter">code</code></dt>
<dd>
<p class="para">
The new code to be evaluated when <code class="parameter">methodname</code>
is called
</p>
</dd>
<dt>
<code class="parameter">closure</code></dt>
<dd>
<p class="para">
A <a href="class.closure.html" class="classname">closure</a> that defines the method.
</p>
</dd>
<dt>
<code class="parameter">flags</code></dt>
<dd>
<p class="para">
The redefined method can be
<strong><code>RUNKIT_ACC_PUBLIC</code></strong>,
<strong><code>RUNKIT_ACC_PROTECTED</code></strong> or
<strong><code>RUNKIT_ACC_PRIVATE</code></strong> optionally combined via bitwise OR with
<strong><code>RUNKIT_ACC_STATIC</code></strong> (since 1.0.1)
</p>
</dd>
<dt>
<code class="parameter">doc_comment</code></dt>
<dd>
<p class="para">
The doc comment of the function.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.runkit-method-redefine-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>
</div>
<div class="refsect1 changelog" id="refsect1-function.runkit-method-redefine-changelog">
<h3 class="title">Changelog</h3>
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>runkit 1.0.4</td>
<td>
An alternative syntax expecting a <code class="parameter">closure</code> has been added.
</td>
</tr>
<tr>
<td>runkit 1.0.4</td>
<td>
The optional parameter <code class="parameter">doc_comment</code> has been added.
</td>
</tr>
</tbody>
</table>
</div>
<div class="refsect1 examples" id="refsect1-function.runkit-method-redefine-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-589">
<p><strong>Example #1 <span class="function"><strong>runkit_method_redefine()</strong></span> 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">Example </span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">foo</span><span style="color: #007700">() {<br /> return </span><span style="color: #DD0000">"foo!\n"</span><span style="color: #007700">;<br /> }<br />}<br /><br /></span><span style="color: #FF8000">// create an Example object<br /></span><span style="color: #0000BB">$e </span><span style="color: #007700">= new </span><span style="color: #0000BB">Example</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// output Example::foo() (before redefine)<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"Before: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">foo</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Redefine the 'foo' method<br /></span><span style="color: #0000BB">runkit_method_redefine</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'Example'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'return "bar!\n";'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">RUNKIT_ACC_PUBLIC<br /></span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// output Example::foo() (after redefine)<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">"After: " </span><span style="color: #007700">. </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">foo</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>
Before: foo!
After: bar!
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.runkit-method-redefine-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.runkit-method-add.html" class="function" rel="rdfs-seeAlso">runkit_method_add()</a> - Dynamically adds a new method to a given class</span></li>
<li class="member"><span class="function"><a href="function.runkit-method-copy.html" class="function" rel="rdfs-seeAlso">runkit_method_copy()</a> - Copies a method from class to another</span></li>
<li class="member"><span class="function"><a href="function.runkit-method-remove.html" class="function" rel="rdfs-seeAlso">runkit_method_remove()</a> - Dynamically removes the given method</span></li>
<li class="member"><span class="function"><a href="function.runkit-method-rename.html" class="function" rel="rdfs-seeAlso">runkit_method_rename()</a> - Dynamically changes the name of the given method</span></li>
<li class="member"><span class="function"><a href="function.runkit-function-redefine.html" class="function" rel="rdfs-seeAlso">runkit_function_redefine()</a> - Replace a function definition with a new implementation</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.runkit-method-copy.html">runkit_method_copy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.runkit-method-remove.html">runkit_method_remove</a></div>
<div class="up"><a href="ref.runkit.html">runkit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
