<!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>Insert element into an array field</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionmodify.arrayappend.html">CollectionModify::arrayAppend</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.bind.html">CollectionModify::bind</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.arrayinsert" class="refentry">
<div class="refnamediv">
<h1 class="refname">CollectionModify::arrayInsert</h1>
<p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionModify::arrayInsert</span> — <span class="dc-title">Insert element into an array field</span></p>
</div>
<div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionmodify.arrayinsert-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::arrayInsert</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">
Add an element to a document's field, as multiple elements of a field are represented as an array.
Unlike arrayAppend(), arrayInsert() allows you to specify where the new element is inserted by
defining which item it is after, whereas arrayAppend() always appends the new element at the end of the array.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionmodify.arrayinsert-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">collection_field</code></dt>
<dd>
<p class="para">
Identify the item in the array that the new element is inserted after.
The format of this parameter is <em>FIELD_NAME[ INDEX ]</em> where
FIELD_NAME is the name of the document field to remove the element from,
and INDEX is the INDEX of the element within the field.
</p>
<p class="para">
The INDEX field is zero based, so the leftmost item from the array has an index of 0.
</p>
</dd>
<dt>
<code class="parameter">expression_or_literal</code></dt>
<dd>
<p class="para">
The new element to insert after FIELD_NAME[ INDEX ]
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionmodify.arrayinsert-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A CollectionModify object that can be used to execute the command, or to add additional operations
</p>
</div>
<div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionmodify.arrayinsert-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2009">
<p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionModify::arrayInsert()</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 in ('Bernie', 'Jane')"</span><span style="color: #007700">)<br /> -></span><span style="color: #0000BB">arrayInsert</span><span style="color: #007700">(</span><span style="color: #DD0000">'traits[1]'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Happy'</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] => 00005b6b5361000000000000010d
[name] => Bernie
[traits] => Array
(
[0] => Friend
[1] => Happy
[2] => Brother
[3] => 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.arrayappend.html">CollectionModify::arrayAppend</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.bind.html">CollectionModify::bind</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>
