<!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>Collection class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-baseresult.getwarningscount.html">BaseResult::getWarningsCount</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.add.html">Collection::add</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-collection" class="reference">
<h1 class="title">Collection class</h1>
<div class="partintro"><p class="verinfo">(PECL mysql-xdevapi >= 8.0.11)</p>
<div class="section" id="mysql-xdevapi-collection.intro">
<h2 class="title">Introduction</h2>
<p class="para">
</p>
</div>
<div class="section" id="mysql-xdevapi-collection.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\Collection</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.mysql-xdevapi-schemaobject.html" class="interfacename">mysql_xdevapi\SchemaObject</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.mysql-xdevapi-collection.html#mysql-xdevapi-collection.props.name">$<var class="varname">name</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionAdd</span> <span class="methodname"><strong>add</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$document</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\Result</span> <span class="methodname"><strong>addOrReplaceOne</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$doc</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">integer</span> <span class="methodname"><strong>count</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><strong>createIndex</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$index_desc_json</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>dropIndex</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$index_name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>existsInDatabase</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionFind</span> <span class="methodname"><strong>find</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$search_condition</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><strong>getName</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Document</span> <span class="methodname"><strong>getOne</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Schema Object</span> <span class="methodname"><strong>getSchema</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Session</span> <span class="methodname"><strong>getSession</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>modify</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$search_condition</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\CollectionRemove</span> <span class="methodname"><strong>remove</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$search_condition</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\Result</span> <span class="methodname"><strong>removeOne</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mysql_xdevapi\Result</span> <span class="methodname"><strong>replaceOne</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$doc</code></span>
)</div>
}</div>
</div>
<div class="section" id="mysql-xdevapi-collection.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="mysql-xdevapi-collection.props.name"><var class="varname"><var class="varname">name</var></var></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mysql-xdevapi-collection.add.html">Collection::add</a> — Add collection document</li><li><a href="mysql-xdevapi-collection.addorreplaceone.html">Collection::addOrReplaceOne</a> — Add or replace collection document</li><li><a href="mysql-xdevapi-collection.construct.html">Collection::__construct</a> — Collection constructor</li><li><a href="mysql-xdevapi-collection.count.html">Collection::count</a> — Get document count</li><li><a href="mysql-xdevapi-collection.createindex.html">Collection::createIndex</a> — Create collection index</li><li><a href="mysql-xdevapi-collection.dropindex.html">Collection::dropIndex</a> — Drop collection index</li><li><a href="mysql-xdevapi-collection.existsindatabase.html">Collection::existsInDatabase</a> — Check if collection exists in database</li><li><a href="mysql-xdevapi-collection.find.html">Collection::find</a> — Search for document</li><li><a href="mysql-xdevapi-collection.getname.html">Collection::getName</a> — Get collection name</li><li><a href="mysql-xdevapi-collection.getone.html">Collection::getOne</a> — Get one document</li><li><a href="mysql-xdevapi-collection.getschema.html">Collection::getSchema</a> — Get schema object</li><li><a href="mysql-xdevapi-collection.getsession.html">Collection::getSession</a> — Get session object</li><li><a href="mysql-xdevapi-collection.modify.html">Collection::modify</a> — Modify collection documents</li><li><a href="mysql-xdevapi-collection.remove.html">Collection::remove</a> — Remove collection documents</li><li><a href="mysql-xdevapi-collection.removeone.html">Collection::removeOne</a> — Remove one collection document</li><li><a href="mysql-xdevapi-collection.replaceone.html">Collection::replaceOne</a> — Replace one collection document</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-baseresult.getwarningscount.html">BaseResult::getWarningsCount</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collection.add.html">Collection::add</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>
