<!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>Sets a client option</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysqlnduhconnection.setcharset.html">MysqlndUhConnection::setCharset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnduhconnection.setserveroption.html">MysqlndUhConnection::setServerOption</a></div>
<div class="up"><a href="class.mysqlnduhconnection.html">MysqlndUhConnection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysqlnduhconnection.setclientoption" class="refentry">
<div class="refnamediv">
<h1 class="refname">MysqlndUhConnection::setClientOption</h1>
<p class="verinfo">(PECL mysqlnd-uh >= 1.0.0-alpha)</p><p class="refpurpose"><span class="refname">MysqlndUhConnection::setClientOption</span> — <span class="dc-title">Sets a client option</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysqlnduhconnection.setclientoption-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>MysqlndUhConnection::setClientOption</strong></span>
( <span class="methodparam"><span class="type"><span class="type mysqlnd_connection">mysqlnd_connection</span></span> <code class="parameter">$connection</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Sets a client option.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysqlnduhconnection.setclientoption-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
Mysqlnd connection handle. Do not modify!
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
The option to be set.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
Optional option value, if required.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysqlnduhconnection.setclientoption-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 examples" id="refsect1-mysqlnduhconnection.setclientoption-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1917">
<p><strong>Example #1 <span class="function"><strong>MysqlndUhConnection::setClientOption()</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">function </span><span style="color: #0000BB">client_option_to_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$option</span><span style="color: #007700">) {<br /> static </span><span style="color: #0000BB">$mapping </span><span style="color: #007700">= array(<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPTION_OPT_CONNECT_TIMEOUT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPTION_OPT_CONNECT_TIMEOUT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPTION_OPT_COMPRESS </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPTION_OPT_COMPRESS"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPTION_OPT_NAMED_PIPE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPTION_OPT_NAMED_PIPE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPTION_INIT_COMMAND </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPTION_INIT_COMMAND"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_READ_DEFAULT_FILE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_READ_DEFAULT_FILE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_READ_DEFAULT_GROUP </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_READ_DEFAULT_GROUP"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_SET_CHARSET_DIR </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_SET_CHARSET_DIR"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_SET_CHARSET_NAME </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_SET_CHARSET_NAME"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_PROTOCOL </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_PROTOCOL"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_SHARED_MEMORY_BASE_NAME </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_SHARED_MEMORY_BASE_NAME"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_READ_TIMEOUT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_READ_TIMEOUT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_WRITE_TIMEOUT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_WRITE_TIMEOUT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_USE_RESULT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_USE_RESULT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_USE_REMOTE_CONNECTION </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_USE_REMOTE_CONNECTION"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_USE_EMBEDDED_CONNECTION </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_USE_EMBEDDED_CONNECTION"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_GUESS_CONNECTION </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_GUESS_CONNECTION"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_SET_CLIENT_IP </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_SET_CLIENT_IP"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_SECURE_AUTH </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_SECURE_AUTH"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_REPORT_DATA_TRUNCATION </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_REPORT_DATA_TRUNCATION"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_RECONNECT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_RECONNECT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_VERIFY_SERVER_CERT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_VERIFY_SERVER_CERT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_NET_CMD_BUFFER_SIZE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_NET_CMD_BUFFER_SIZE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_NET_READ_BUFFER_SIZE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_NET_READ_BUFFER_SIZE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_KEY </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_KEY"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_CERT </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_CERT"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_CA </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_CA"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_CAPATH </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_CAPATH"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_CIPHER </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_CIPHER"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_SSL_PASSPHRASE </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_SSL_PASSPHRASE"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_SERVER_OPTION_PLUGIN_DIR </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_SERVER_OPTION_PLUGIN_DIR"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_SERVER_OPTION_DEFAULT_AUTH </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_SERVER_OPTION_DEFAULT_AUTH"</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">MYSQLND_UH_SERVER_OPTION_SET_CLIENT_IP </span><span style="color: #007700">=> </span><span style="color: #DD0000">"MYSQLND_UH_SERVER_OPTION_SET_CLIENT_IP"<br /> </span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">version_compare</span><span style="color: #007700">(</span><span style="color: #0000BB">PHP_VERSION</span><span style="color: #007700">, </span><span style="color: #DD0000">'5.3.99-dev'</span><span style="color: #007700">, </span><span style="color: #DD0000">'>'</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$mapping</span><span style="color: #007700">[</span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET</span><span style="color: #007700">] = </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET"</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$mapping</span><span style="color: #007700">[</span><span style="color: #0000BB">MYSQLND_UH_MYSQLND_OPT_AUTH_PROTOCOL</span><span style="color: #007700">] = </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_AUTH_PROTOCOL"</span><span style="color: #007700">;<br /> }<br /> if (</span><span style="color: #0000BB">defined</span><span style="color: #007700">(</span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE"</span><span style="color: #007700">)) {<br /> </span><span style="color: #FF8000">/* special mysqlnd build */<br /> </span><span style="color: #0000BB">$mapping</span><span style="color: #007700">[</span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE"</span><span style="color: #007700">] = </span><span style="color: #DD0000">"MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE"</span><span style="color: #007700">;<br /> }<br /> return (isset(</span><span style="color: #0000BB">$mapping</span><span style="color: #007700">[</span><span style="color: #0000BB">$option</span><span style="color: #007700">])) ? </span><span style="color: #0000BB">$mapping</span><span style="color: #007700">[</span><span style="color: #0000BB">$option</span><span style="color: #007700">] : </span><span style="color: #DD0000">'unknown'</span><span style="color: #007700">;<br />}<br /><br />class </span><span style="color: #0000BB">proxy </span><span style="color: #007700">extends </span><span style="color: #0000BB">MysqlndUhConnection </span><span style="color: #007700">{<br /> public function </span><span style="color: #0000BB">setClientOption</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #0000BB">$option</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s(%s)\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">__METHOD__</span><span style="color: #007700">, </span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">func_get_args</span><span style="color: #007700">(), </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Option '%s' set to %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">client_option_to_string</span><span style="color: #007700">(</span><span style="color: #0000BB">$option</span><span style="color: #007700">), </span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$value</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">parent</span><span style="color: #007700">::</span><span style="color: #0000BB">setClientOption</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #0000BB">$option</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s returns %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">__METHOD__</span><span style="color: #007700">, </span><span style="color: #0000BB">var_export</span><span style="color: #007700">(</span><span style="color: #0000BB">$ret</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">));<br /> return </span><span style="color: #0000BB">$ret</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">mysqlnd_uh_set_connection_proxy</span><span style="color: #007700">(new </span><span style="color: #0000BB">proxy</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">$mysqli </span><span style="color: #007700">= new </span><span style="color: #0000BB">mysqli</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"root"</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</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>
proxy::setClientOption(array (
0 => NULL,
1 => 210,
2 => 3221225472,
))
Option 'MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET' set to 3221225472
proxy::setClientOption returns true
proxy::setClientOption(array (
0 => NULL,
1 => 211,
2 => 'mysql_native_password',
))
Option 'MYSQLND_UH_MYSQLND_OPT_AUTH_PROTOCOL' set to 'mysql_native_password'
proxy::setClientOption returns true
proxy::setClientOption(array (
0 => NULL,
1 => 8,
2 => 1,
))
Option 'MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE' set to 1
proxy::setClientOption returns true
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-mysqlnduhconnection.setclientoption-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">
<span class="function"><a href="mysqli.real-connect.html" class="function" rel="rdfs-seeAlso">mysqli_real_connect()</a> - Opens a connection to a mysql server</span>
</li>
<li class="member">
<span class="function"><a href="mysqli.options.html" class="function" rel="rdfs-seeAlso">mysqli_options()</a> - Set options</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="mysqlnduhconnection.setcharset.html">MysqlndUhConnection::setCharset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysqlnduhconnection.setserveroption.html">MysqlndUhConnection::setServerOption</a></div>
<div class="up"><a href="class.mysqlnduhconnection.html">MysqlndUhConnection</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
