<!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>Installs a proxy for mysqlnd statements</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mysqlnd-uh-set-connection-proxy.html">mysqlnd_uh_set_connection_proxy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnd-uh.changes.html">Change History</a></div>
<div class="up"><a href="ref.mysqlnd-uh.html">Mysqlnd_uh Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mysqlnd-uh-set-statement-proxy" class="refentry">
<div class="refnamediv">
<h1 class="refname">mysqlnd_uh_set_statement_proxy</h1>
<p class="verinfo">(PECL mysqlnd-uh >= 1.0.0-alpha)</p><p class="refpurpose"><span class="refname">mysqlnd_uh_set_statement_proxy</span> — <span class="dc-title">Installs a proxy for mysqlnd statements</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mysqlnd-uh-set-statement-proxy-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>mysqlnd_uh_set_statement_proxy</strong></span>
( <span class="methodparam"><span class="type"><span class="type MysqlndUhStatement">MysqlndUhStatement</span></span> <code class="parameter reference">&$statement_proxy</code></span>
)</div>
<p class="para rdfs-comment">
Installs a proxy for mysqlnd statements.
The proxy object will be used for all mysqlnd prepared
statement objects, regardless which PHP MySQL extension
(<a href="ref.mysqli.html" class="link">mysqli</a>,
<a href="ref.mysql.html" class="link">mysql</a>,
<a href="ref.pdo-mysql.html" class="link">PDO_MYSQL</a>)
has created them as long as the extension is compiled
to use the <a href="book.mysqlnd.html" class="link">mysqlnd</a>
library.
</p>
<p class="para">
The function can be disabled with
<em><a href="mysqlnd-uh.configuration.html#ini.mysqlnd-uh.enable" class="link">mysqlnd_uh.enable</a></em>.
If <em><a href="mysqlnd-uh.configuration.html#ini.mysqlnd-uh.enable" class="link">mysqlnd_uh.enable</a></em>
is set to <strong><code>FALSE</code></strong> the function will not install the proxy and
always return <strong><code>TRUE</code></strong>. Additionally, an error of the
type <em>E_WARNING</em> may be emitted. The error message may
read like <em>PHP Warning: mysqlnd_uh_set_statement_proxy(): (Mysqlnd User Handler)
The plugin has been disabled by setting the configuration parameter mysqlnd_uh.enable = false.
The proxy has not been installed [...]</em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mysqlnd-uh-set-statement-proxy-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">statement_proxy</code></em></span>
<dd>
<p class="para">
The mysqlnd statement proxy object of type <em>MysqlndUhStatement</em>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mysqlnd-uh-set-statement-proxy-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
Otherwise, returns <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.mysqlnd-uh-set-statement-proxy-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member">
<span class="function"><a href="function.mysqlnd-uh-set-connection-proxy.html" class="function" rel="rdfs-seeAlso">mysqlnd_uh_set_connection_proxy()</a> - Installs a proxy for mysqlnd connections</span>
</li>
<li class="member">
<em><a href="mysqlnd-uh.configuration.html#ini.mysqlnd-uh.enable" class="link">mysqlnd_uh.enable</a></em>
</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.mysqlnd-uh-set-connection-proxy.html">mysqlnd_uh_set_connection_proxy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnd-uh.changes.html">Change History</a></div>
<div class="up"><a href="ref.mysqlnd-uh.html">Mysqlnd_uh Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
