<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.mysql-xdevapi.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'class.mysql-xdevapi-collection.php',
    1 => 'mysql_xdevapi\\Collection',
    2 => 'Collection class',
  ),
  'up' => 
  array (
    0 => 'book.mysql-xdevapi.php',
    1 => 'Mysql_xdevapi',
  ),
  'prev' => 
  array (
    0 => 'mysql-xdevapi-client.getsession.php',
    1 => 'Client::getClient',
  ),
  'next' => 
  array (
    0 => 'mysql-xdevapi-collection.add.php',
    1 => 'Collection::add',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mysql_xdevapi/mysql-xdevapi.collection.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.mysql-xdevapi-collection.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.mysql-xdevapi-collection" class="reference">

 <h1 class="title">Collection class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL mysql-xdevapi &gt;= 8.0.11)</p>


  <div class="section" id="mysql-xdevapi-collection.intro">
   <h2 class="title">简介</h2>
   <p class="para">

   </p>
  </div>


  <div class="section" id="mysql-xdevapi-collection.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">mysql_xdevapi\Collection</strong>
     </span>
     
     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.mysql-xdevapi-schemaobject.php" class="interfacename">mysql_xdevapi\SchemaObject</a></span> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
      <var class="varname"><a href="class.mysql-xdevapi-collection.php#mysql-xdevapi-collection.props.name">$<var class="varname">name</var></a></var>;</div>


    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>add</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$document</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionadd.php" class="type mysql_xdevapi\CollectionAdd">mysql_xdevapi\CollectionAdd</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>addOrReplaceOne</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$id</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$doc</code></span>): <span class="type"><a href="class.mysql-xdevapi-result.php" class="type mysql_xdevapi\Result">mysql_xdevapi\Result</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>count</strong></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>createIndex</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$index_name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$index_desc_json</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>dropIndex</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$index_name</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>existsInDatabase</strong></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>find</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$search_condition</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="class.mysql-xdevapi-collectionfind.php" class="type mysql_xdevapi\CollectionFind">mysql_xdevapi\CollectionFind</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>getName</strong></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>getOne</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$id</code></span>): <span class="type">Document</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>getSchema</strong></span>(): <span class="type">Schema Object</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>getSession</strong></span>(): <span class="type">Session</span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>modify</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$search_condition</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionmodify.php" class="type mysql_xdevapi\CollectionModify">mysql_xdevapi\CollectionModify</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>remove</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$search_condition</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionremove.php" class="type mysql_xdevapi\CollectionRemove">mysql_xdevapi\CollectionRemove</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>removeOne</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$id</code></span>): <span class="type"><a href="class.mysql-xdevapi-result.php" class="type mysql_xdevapi\Result">mysql_xdevapi\Result</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>replaceOne</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$id</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$doc</code></span>): <span class="type"><a href="class.mysql-xdevapi-result.php" class="type mysql_xdevapi\Result">mysql_xdevapi\Result</a></span></div>

   }</div>


  </div>

  

  <div class="section" id="mysql-xdevapi-collection.props">
   <h2 class="title">属性</h2>
   <dl>
    
     <dt id="mysql-xdevapi-collection.props.name"><var class="varname">name</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
   </dl>
  </div>



 </div>

 












































































































<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="mysql-xdevapi-collection.add.php">Collection::add</a> — Add collection document</li><li><a href="mysql-xdevapi-collection.addorreplaceone.php">Collection::addOrReplaceOne</a> — Add or replace collection document</li><li><a href="mysql-xdevapi-collection.construct.php">Collection::__construct</a> — Collection constructor</li><li><a href="mysql-xdevapi-collection.count.php">Collection::count</a> — Get document count</li><li><a href="mysql-xdevapi-collection.createindex.php">Collection::createIndex</a> — Create collection index</li><li><a href="mysql-xdevapi-collection.dropindex.php">Collection::dropIndex</a> — Drop collection index</li><li><a href="mysql-xdevapi-collection.existsindatabase.php">Collection::existsInDatabase</a> — Check if collection exists in database</li><li><a href="mysql-xdevapi-collection.find.php">Collection::find</a> — Search for document</li><li><a href="mysql-xdevapi-collection.getname.php">Collection::getName</a> — Get collection name</li><li><a href="mysql-xdevapi-collection.getone.php">Collection::getOne</a> — Get one document</li><li><a href="mysql-xdevapi-collection.getschema.php">Collection::getSchema</a> — Get schema object</li><li><a href="mysql-xdevapi-collection.getsession.php">Collection::getSession</a> — Get session object</li><li><a href="mysql-xdevapi-collection.modify.php">Collection::modify</a> — Modify collection documents</li><li><a href="mysql-xdevapi-collection.remove.php">Collection::remove</a> — Remove collection documents</li><li><a href="mysql-xdevapi-collection.removeone.php">Collection::removeOne</a> — Remove one collection document</li><li><a href="mysql-xdevapi-collection.replaceone.php">Collection::replaceOne</a> — Replace one collection document</li></ul>
</div>
<?php manual_footer($setup); ?>