archived-doc-es/reference/mongo/mongocursor/setflag.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cf27b67a875508d7a42d793055719d8723ea79a1 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="mongocursor.setflag" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>MongoCursor::setFlag</refname>
  <refpurpose>Establece banderas arbitrarias en caso de que no haya métodos disponibles para una bandera específica</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::setFlag</methodname>
   <methodparam><type>int</type><parameter>flag</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>set</parameter><initializer>true</initializer></methodparam>
  </methodsynopsis>
  <para>
   La clase <classname>MongoCursor</classname> posee varios métodos para
   establecer banderas en el objeto de consulta. Este método está disponible en caso de que
   el protocolo de cable de MongoDB haya adquirido una nueva bandera, y el controlador no haya
   sido actualizado con un método para esta nueva bandera. El los demás casos, se debería usar
   el método. Véase la sección "Ver también" para los métodos disponibles.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>flag</parameter>
     </term>
     <listitem>
      <para>
       Qué bandera establecer. No se puede establecer la bandera 6 (EXHAUST), ya que el controlador no sabe
       como manejarla. Se generará una advertencia si se intenta usarla. Para las banderas disponibles, cosulte la
       <link xlink:href="&url.mongodb.dochub.wireprotocol;#MongoWireProtocol-OPQUERY">documentación</link>
       del protocolo de cable.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>set</parameter>
     </term>
     <listitem>
      <para>
       Si debería establecerse la bandera (&true;) o no (&false;).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1> 
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;  
  <para>
   Devuelve este cursor.
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Muestra una advertencia al intentar establecer una bandera no soportada.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>1.4.0</entry>
       <entry>
        Se añadió el soporte para la bandera 3 (OPLOG_REPLAY). Las versiones anteriorea a la
        1.4.0 lanzarán una advertencia diciendo que la bandera no está soportada.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Ejemplo de <function>MongoCursor::setFlag</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$m = new MongoClient( 'mongodb://localhost:13000', array( 'replSet' => 'seta' ) );
$c = $m->local->selectCollection( 'oplog.rs' );
$cursor = $c->find( array( 'ns' => 'demo.article', 'op' => 'i' ) );
$cursor->setFlag( 1, true ); // sets the tailable flag
$cursor->setFlag( 5, true ); // sets the await data flag
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>MongoCursor::tailable</function></member>
    <member><function>MongoCursor::immortal</function></member>
    <member><function>MongoCursor::awaitData</function></member>
    <member><function>MongoCursor::partial</function></member>
    <member>La documentación principal de MongoDB sobre <link xlink:href="&url.mongodb.dochub.wireprotocol;#MongoWireProtocol-OPQUERY">banderas de consulta del protocolo de cable</link></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->