MongoCursor::setFlag

(PECL mongo >=1.2.11)

MongoCursor::setFlagDéfinit des drapeaux dans le cas où aucune méthode dédiée n'est disponible

Description

public MongoCursor MongoCursor::setFlag ( int $flag [, bool $set = true ] )

La classe MongoCursor possède plusieurs méthodes pour définir des drapeaux sur l'objet de requête. Cette méthode est disponible dans le cas où le protocole MongoDB se voit ajouter un nouveau drapeau, et que le driver n'a pas été mis à jour avec une nouvelle méthode permettant de le définir. Dans tous les cas, la méthode doit être préférée. Voir la section "Voir aussi" pour les méthodes disponibles.

Liste de paramètres

flag

Le drapeau à définir. Vous ne pouvez pas définir le drapeau n°6 (EXHAUST) sachant que le driver ne sait pas comment le gérer. Vous recevrez une alerte si vous tentez d'utiliser ce drapeau. Pour avoir une liste des drapeaux disponibles, référez-vous à la » documentation du protocole.

set

Si le drapeau doit être défini (TRUE) ou supprimé (FALSE).

Valeurs de retour

Retourne le curseur.

Erreurs / Exceptions

Affiche une alerte lorsque l'on tente de définir un drapeau non-supporté.

Historique

Version Description
1.4.0 Ajout du support du drapeau n°3 (OPLOG_REPLAY). Les versions antérieures à 1.4.0 émettront une alerte indiquant que le drapeau n'est pas supporté..

Exemples

Exemple #1 Exemple avec MongoCursor::setFlag()

<?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 ); // définit le drapeau tailable
$cursor->setFlag( 5, true ); // définit le drapeau "await data"
?>

Voir aussi

LoadingChargement en cours