<!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>Set document attribute</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionmodify.replace.html">CollectionModify::replace</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.skip.html">CollectionModify::skip</a></div> <div class="up"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mysql-xdevapi-collectionmodify.set" class="refentry"> <div class="refnamediv"> <h1 class="refname">CollectionModify::set</h1> <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionModify::set</span> — <span class="dc-title">Set document attribute</span></p> </div> <div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionmodify.set-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\CollectionModify">mysql_xdevapi\CollectionModify</span></span> <span class="methodname"><strong>mysql_xdevapi\CollectionModify::set</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$collection_field</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$expression_or_literal</code></span> )</div> <p class="para rdfs-comment"> Sets or updates attributes on documents in a collection. </p> </div> <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionmodify.set-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">collection_field</code></dt> <dd> <p class="para"> The document path (name) of the item to set. </p> </dd> <dt> <code class="parameter">expression_or_literal</code></dt> <dd> <p class="para"> The value to set it to. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionmodify.set-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A CollectionModify object. </p> </div> <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionmodify.set-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-2016"> <p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionModify::set()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">'{"name": "Bernie",<br /> "traits": ["Friend", "Brother", "Human"]}'</span><span style="color: #007700">) <br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">modify</span><span style="color: #007700">(</span><span style="color: #DD0000">"name = :name"</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">bind</span><span style="color: #007700">([</span><span style="color: #DD0000">'name' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'Bernie'</span><span style="color: #007700">])<br /> -></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"name"</span><span style="color: #007700">, </span><span style="color: #DD0000">"Bern"</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$collection<br /> </span><span style="color: #007700">-></span><span style="color: #0000BB">find</span><span style="color: #007700">()<br /> -></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">-></span><span style="color: #0000BB">fetchAll</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> Array ( [0] => Array ( [_id] => 00005b6b53610000000000000111 [name] => Bern [traits] => Array ( [0] => Friend [1] => Brother [2] => Human ) ) ) </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="mysql-xdevapi-collectionmodify.replace.html">CollectionModify::replace</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.skip.html">CollectionModify::skip</a></div> <div class="up"><a href="class.mysql-xdevapi-collectionmodify.html">mysql_xdevapi\CollectionModify</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>