<!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>CollectionModify class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.sort.html">CollectionFind::sort</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.arrayappend.html">CollectionModify::arrayAppend</a></div> <div class="up"><a href="book.mysql-xdevapi.html">Mysql_xdevapi</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.mysql-xdevapi-collectionmodify" class="reference"> <h1 class="title">CollectionModify class</h1> <div class="partintro"><p class="verinfo">(PECL mysql-xdevapi >= 8.0.11)</p> <div class="section" id="mysql-xdevapi-collectionmodify.intro"> <h2 class="title">Introduction</h2> <p class="para"> </p> </div> <div class="section" id="mysql-xdevapi-collectionmodify.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">mysql_xdevapi\CollectionModify</strong> </span> <span class="oointerface">implements <span class="interfacename"><a href="class.mysql-xdevapi-executable.html" class="interfacename">mysql_xdevapi\Executable</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.mysql-xdevapi-crudoperationbindable.html" class="interfacename">mysql_xdevapi\CrudOperationBindable</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.mysql-xdevapi-crudoperationlimitable.html" class="interfacename">mysql_xdevapi\CrudOperationLimitable</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.mysql-xdevapi-crudoperationskippable.html" class="interfacename">mysql_xdevapi\CrudOperationSkippable</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.mysql-xdevapi-crudoperationsortable.html" class="interfacename">mysql_xdevapi\CrudOperationSortable</a></span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>arrayAppend</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> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>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> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>bind</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$placeholder_values</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\Result</span> <span class="methodname"><strong>execute</strong></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>limit</strong></span> ( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$rows</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>patch</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$document</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>replace</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> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>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> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>skip</strong></span> ( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$position</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>sort</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$sort_expr</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionModify</span> <span class="methodname"><strong>unset</strong></span> ( <span class="methodparam"><span class="type">array</span> <code class="parameter">$fields</code></span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mysql-xdevapi-collectionmodify.arrayappend.html">CollectionModify::arrayAppend</a> — Append element to an array field</li><li><a href="mysql-xdevapi-collectionmodify.arrayinsert.html">CollectionModify::arrayInsert</a> — Insert element into an array field</li><li><a href="mysql-xdevapi-collectionmodify.bind.html">CollectionModify::bind</a> — Bind value to query placeholder</li><li><a href="mysql-xdevapi-collectionmodify.construct.html">CollectionModify::__construct</a> — CollectionModify constructor</li><li><a href="mysql-xdevapi-collectionmodify.execute.html">CollectionModify::execute</a> — Execute modify operation</li><li><a href="mysql-xdevapi-collectionmodify.limit.html">CollectionModify::limit</a> — Limit number of modified documents</li><li><a href="mysql-xdevapi-collectionmodify.patch.html">CollectionModify::patch</a> — Patch document</li><li><a href="mysql-xdevapi-collectionmodify.replace.html">CollectionModify::replace</a> — Replace document field</li><li><a href="mysql-xdevapi-collectionmodify.set.html">CollectionModify::set</a> — Set document attribute</li><li><a href="mysql-xdevapi-collectionmodify.skip.html">CollectionModify::skip</a> — Skip elements</li><li><a href="mysql-xdevapi-collectionmodify.sort.html">CollectionModify::sort</a> — Set the sorting criteria</li><li><a href="mysql-xdevapi-collectionmodify.unset.html">CollectionModify::unset</a> — Unset the value of document fields</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.sort.html">CollectionFind::sort</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionmodify.arrayappend.html">CollectionModify::arrayAppend</a></div> <div class="up"><a href="book.mysql-xdevapi.html">Mysql_xdevapi</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>