<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/mongodb.mongodb.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'class.mongodb-driver-command.php',
    1 => 'MongoDB\\Driver\\Command',
    2 => 'A classe MongoDB\\Driver\\Command',
  ),
  'up' => 
  array (
    0 => 'mongodb.mongodb.php',
    1 => 'MongoDB\\Driver',
  ),
  'prev' => 
  array (
    0 => 'mongodb-driver-manager.startsession.php',
    1 => 'MongoDB\\Driver\\Manager::startSession',
  ),
  'next' => 
  array (
    0 => 'mongodb-driver-command.construct.php',
    1 => 'MongoDB\\Driver\\Command::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/mongodb/mongodb/driver/command.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.mongodb-driver-command.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.mongodb-driver-command" class="reference">

 <h1 class="title">A classe MongoDB\Driver\Command</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.0.0)</p>


  <div class="section" id="mongodb-driver-command.intro">
   <h2 class="title">Introdução</h2>
   <p class="para">
    A classe <span class="classname"><strong class="classname">MongoDB\Driver\Command</strong></span> é um objeto de valor
    que representa um comando de banco de dados.
   </p>
   <p class="para">
    Para fornecer <q class="quote">Auxílios de Comando</q>, o objeto <span class="classname"><strong class="classname">MongoDB\Driver\Command</strong></span> deve ser composto.
   </p>
  </div>


  <div class="section" id="mongodb-driver-command.synopsis">
   <h2 class="title">Resumo da classe</h2>


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


    <div class="classsynopsisinfo">
     <span class="modifier">final</span>
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">MongoDB\Driver\Command</strong>
     </span>
     {</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-command.construct.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span> <code class="parameter">$document</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$commandOptions</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>)</div>

   }</div>


  </div>

  <div class="section" id="mongodb-driver-command.examples">
   <h2 class="title">Exemplos</h2>

   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Compondo o objeto <span class="classname"><strong class="classname">MongoDB\Driver\Command</strong></span> para fornecer um auxílio na criação de coleções</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">CreateCollection </span><span style="color: #007700">{<br />    protected </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= array();<br /><br />    function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$collectionName</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"create"</span><span style="color: #007700">] = (string) </span><span style="color: #0000BB">$collectionName</span><span style="color: #007700">;<br />    }<br />    function </span><span style="color: #0000BB">setCappedCollection</span><span style="color: #007700">(</span><span style="color: #0000BB">$maxBytes</span><span style="color: #007700">, </span><span style="color: #0000BB">$maxDocuments </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"capped"</span><span style="color: #007700">] = </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />        </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"size"</span><span style="color: #007700">]   = (int) </span><span style="color: #0000BB">$maxBytes</span><span style="color: #007700">;<br /><br />        if (</span><span style="color: #0000BB">$maxDocuments</span><span style="color: #007700">) {<br />            </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"max"</span><span style="color: #007700">] = (int) </span><span style="color: #0000BB">$maxDocuments</span><span style="color: #007700">;<br />        }<br />    }<br />    function </span><span style="color: #0000BB">usePowerOf2Sizes</span><span style="color: #007700">(</span><span style="color: #0000BB">$bool</span><span style="color: #007700">) {<br />        if (</span><span style="color: #0000BB">$bool</span><span style="color: #007700">) {<br />            </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"flags"</span><span style="color: #007700">] = </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br />        } else {<br />            </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"flags"</span><span style="color: #007700">] = </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br />        }<br />    }<br />    function </span><span style="color: #0000BB">setFlags</span><span style="color: #007700">(</span><span style="color: #0000BB">$flags</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"flags"</span><span style="color: #007700">] = (int) </span><span style="color: #0000BB">$flags</span><span style="color: #007700">;<br />    }<br />    function </span><span style="color: #0000BB">getCommand</span><span style="color: #007700">() {<br />        return new </span><span style="color: #0000BB">MongoDB\Driver\Command</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">);<br />    }<br />    function </span><span style="color: #0000BB">getCollectionName</span><span style="color: #007700">() {<br />        return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cmd</span><span style="color: #007700">[</span><span style="color: #DD0000">"create"</span><span style="color: #007700">];<br />    }<br />}<br /><br /><br /></span><span style="color: #0000BB">$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB\Driver\Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://localhost:27017"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$createCollection </span><span style="color: #007700">= new </span><span style="color: #0000BB">CreateCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"cappedCollection"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$createCollection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setCappedCollection</span><span style="color: #007700">(</span><span style="color: #0000BB">64 </span><span style="color: #007700">* </span><span style="color: #0000BB">1024</span><span style="color: #007700">);<br /><br />try {<br />    </span><span style="color: #0000BB">$command </span><span style="color: #007700">= </span><span style="color: #0000BB">$createCollection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCommand</span><span style="color: #007700">();<br />    </span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">executeCommand</span><span style="color: #007700">(</span><span style="color: #DD0000">"databaseName"</span><span style="color: #007700">, </span><span style="color: #0000BB">$command</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">toArray</span><span style="color: #007700">()[</span><span style="color: #0000BB">0</span><span style="color: #007700">];<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">);<br /><br />    </span><span style="color: #0000BB">$collstats </span><span style="color: #007700">= [</span><span style="color: #DD0000">"collstats" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">$createCollection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCollectionName</span><span style="color: #007700">()];<br />    </span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">executeCommand</span><span style="color: #007700">(</span><span style="color: #DD0000">"databaseName"</span><span style="color: #007700">, new </span><span style="color: #0000BB">MongoDB\Driver\Command</span><span style="color: #007700">(</span><span style="color: #0000BB">$collstats</span><span style="color: #007700">));<br />    </span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">toArray</span><span style="color: #007700">()[</span><span style="color: #0000BB">0</span><span style="color: #007700">];<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">);<br />} catch(</span><span style="color: #0000BB">MongoDB\Driver\Exception $e</span><span style="color: #007700">) {<br />    echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />    exit;<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   <p class="para">O exemplo acima produzirá:</p>
   <div class="example-contents screen">
<div class="cdata"><pre>
object(MongoDB\Driver\Command)#3 (1) {
  [&quot;command&quot;]=&gt;
  array(3) {
    [&quot;create&quot;]=&gt;
    string(16) &quot;cappedCollection&quot;
    [&quot;capped&quot;]=&gt;
    bool(true)
    [&quot;size&quot;]=&gt;
    int(65536)
  }
}
array(1) {
  [&quot;ok&quot;]=&gt;
  float(1)
}
array(16) {
  [&quot;ns&quot;]=&gt;
  string(29) &quot;databaseName.cappedCollection&quot;
  [&quot;count&quot;]=&gt;
  int(0)
  [&quot;size&quot;]=&gt;
  int(0)
  [&quot;numExtents&quot;]=&gt;
  int(1)
  [&quot;storageSize&quot;]=&gt;
  int(65536)
  [&quot;nindexes&quot;]=&gt;
  int(1)
  [&quot;lastExtentSize&quot;]=&gt;
  float(65536)
  [&quot;paddingFactor&quot;]=&gt;
  float(1)
  [&quot;paddingFactorNote&quot;]=&gt;
  string(101) &quot;paddingFactor is unused and unmaintained in 2.8. It remains hard coded to 1.0 for compatibility only.&quot;
  [&quot;userFlags&quot;]=&gt;
  int(0)
  [&quot;capped&quot;]=&gt;
  bool(true)
  [&quot;max&quot;]=&gt;
  int(9223372036854775807)
  [&quot;maxSize&quot;]=&gt;
  int(65536)
  [&quot;totalIndexSize&quot;]=&gt;
  int(8176)
  [&quot;indexSizes&quot;]=&gt;
  object(stdClass)#4 (1) {
    [&quot;_id_&quot;]=&gt;
    int(8176)
  }
  [&quot;ok&quot;]=&gt;
  float(1)
}
</pre></div>
   </div>
  </div>

 </div>

 







<h2>Índice</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-command.construct.php">MongoDB\Driver\Command::__construct</a> — Cria um novo comando</li></ul>
</div>
<?php manual_footer($setup); ?>