<!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>Duplicates the closure with a new bound object and class scope</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="closure.bind.html">Closure::bind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="closure.call.html">Closure::call</a></div>
<div class="up"><a href="class.closure.html">Closure</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="closure.bindto" class="refentry">
<div class="refnamediv">
<h1 class="refname">Closure::bindTo</h1>
<p class="verinfo">(PHP 5 >= 5.4.0, PHP 7)</p><p class="refpurpose"><span class="refname">Closure::bindTo</span> — <span class="dc-title">
Duplicates the closure with a new bound object and class scope
</span></p>
</div>
<div class="refsect1 description" id="refsect1-closure.bindto-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.closure.html" class="type Closure">Closure</a></span> <span class="methodname"><strong>Closure::bindTo</strong></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$newthis</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">$newscope</code>
<span class="initializer"> = "static"</span></span>
] )</div>
<p class="para rdfs-comment">
Create and return a new <a href="functions.anonymous.html" class="link">anonymous
function</a> with the same body and bound variables as this one, but
possibly with a different bound object and a new class scope.
</p>
<p class="para">
The “bound object” determines the value <em>$this</em> will
have in the function body and the “class scope” represents a class
which determines which private and protected members the anonymous
function will be able to access. Namely, the members that will be
visible are the same as if the anonymous function were a method of
the class given as value of the <code class="parameter">newscope</code>
parameter.
</p>
<p class="para">
Static closures cannot have any bound object (the value of the parameter
<code class="parameter">newthis</code> should be <strong><code>NULL</code></strong>), but this function can
nevertheless be used to change their class scope.
</p>
<p class="para">
This function will ensure that for a non-static closure, having a bound
instance will imply being scoped and vice-versa. To this end,
non-static closures that are given a scope but a <strong><code>NULL</code></strong> instance are made
static and non-static non-scoped closures that are given a non-null
instance are scoped to an unspecified class.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
If you only want to duplicate the anonymous functions, you can use
<a href="language.oop5.cloning.html" class="link">cloning</a> instead.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-closure.bindto-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">newthis</code></dt>
<dd>
<p class="para">
The object to which the given anonymous function should be bound, or
<strong><code>NULL</code></strong> for the closure to be unbound.
</p>
</dd>
<dt>
<code class="parameter">newscope</code></dt>
<dd>
<p class="para">
The class scope to which associate the closure is to be associated, or
'static' to keep the current one. If an object is given, the type of the
object will be used instead. This determines the visibility of protected
and private methods of the bound object.
It is not allowed to pass (an object of) an internal class as this parameter.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-closure.bindto-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the newly created <a href="class.closure.html" class="classname">Closure</a> object
or <strong><code>FALSE</code></strong> on failure
</p>
</div>
<div class="refsect1 changelog" id="refsect1-closure.bindto-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>7.0.0</td>
<td>
<code class="parameter">newscope</code> can not be (an object of) an internal
class anymore, what was possible prior to this version.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-closure.bindto-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-329">
<p><strong>Example #1 <span class="function"><strong>Closure::bindTo()</strong></span> example</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">class </span><span style="color: #0000BB">A </span><span style="color: #007700">{<br /> function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">val </span><span style="color: #007700">= </span><span style="color: #0000BB">$val</span><span style="color: #007700">;<br /> }<br /> function </span><span style="color: #0000BB">getClosure</span><span style="color: #007700">() {<br /> </span><span style="color: #FF8000">//returns closure bound to this object and scope<br /> </span><span style="color: #007700">return function() { return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">val</span><span style="color: #007700">; };<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$ob1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">A</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$ob2 </span><span style="color: #007700">= new </span><span style="color: #0000BB">A</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$cl </span><span style="color: #007700">= </span><span style="color: #0000BB">$ob1</span><span style="color: #007700">-></span><span style="color: #0000BB">getClosure</span><span style="color: #007700">();<br />echo </span><span style="color: #0000BB">$cl</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$cl </span><span style="color: #007700">= </span><span style="color: #0000BB">$cl</span><span style="color: #007700">-></span><span style="color: #0000BB">bindTo</span><span style="color: #007700">(</span><span style="color: #0000BB">$ob2</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$cl</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
1
2
</pre></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-closure.bindto-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="functions.anonymous.html" class="link">Anonymous functions</a></li>
<li class="member"><span class="methodname"><a href="closure.bind.html" class="methodname" rel="rdfs-seeAlso">Closure::bind()</a> - Duplicates a closure with a specific bound object and class scope</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="closure.bind.html">Closure::bind</a></div>
<div class="next" style="text-align: right; float: right;"><a href="closure.call.html">Closure::call</a></div>
<div class="up"><a href="class.closure.html">Closure</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
