PHP 7.2.25 Released

MongoCollection::findOne

(PECL mongo >=0.9.0)

MongoCollection::findOneInterroge cette collection, retourne un seul élément

Description

public MongoCollection::findOne ([ array $query = array() [, array $fields = array() [, array $options = array() ]]] ) : array

Contrairement à la méthode MongoCollection::find(), cette méthode retournera seulement le premier résultat du jeu de données, et non un MongoCursor sur lequel on aurait pu boucler.

Liste de paramètres

query

Le champ dans lequel la recherche va s'effectuer. Le langage de requête MongoDB est relativement extensible. Le driver PHP passera dans la plupart des cas la requête au serveur, aussi, nous vous invitons à lire la documentation du coeur de MongoDB sur » find pour mieux comprendre le fonctionnement.

Avertissement

Assurez-vous que pour tous les opérateurs spéciaux de la requête (ceux commençant par $) vous utilisez des guillemets simples, ainsi, PHP ne tentera pas de remplacer "$exists" avec la valeur de la variable $exists.

fields

Les champs de résultat à retourner. Le tableau est au format array('fieldname' => true, 'fieldname2' => true). Le champ _id sera, quant à lui, toujours retourné.

options

Ce paramètre est un tableau associatif sous la forme array("nom" => <valeur>, ...). Les options actuellement supportées sont :

  • "maxTimeMS"

    Spécifie une limite cumulative de temps, en millisecondes, pour procéder à l'opération (n'inclut pas le temps d'inactivité). Si l'opération n'est pas terminée durant cette période, une exception MongoExecutionTimeoutException sera émise.

Valeurs de retour

Retourne les enregistrements qui correspondent aux critères, ou bien NULL.

Erreurs / Exceptions

Lance une exception MongoConnectionException si l'on ne peut joindre la base de données.

Historique

Version Description
1.5.0 Ajout de l'argument optionnel options.

Exemples

Exemple #1 MongoCollection::findOne() Cherche un document par son id.

Cet exemple montre comment récupérer un document dans une collection par son id.

<?php

$articles 
$mongo->my_db->articles;

$article $articles->findOne(array('_id' => new MongoId('47cc67093475061e3d9536d2')));

?>

Exemple #2 MongoCollection::findOne() Cherche un document par condition.

Cet exemple montre comment récupérer un document dans une collection au moyen d'un condition en limitant les champs retournés.

<?php

$users 
$mongo->my_db->users;
$user $users->findOne(array('username' => 'jwage'), array('password'));
print_r($user);

?>

L'exemple ci-dessus va afficher quelque chose de similaire à :

Array
(
    [_id] => MongoId Object
        (
        )

    [password] => test
)

Remarquez que même si le document possède un champ username, nous limitons les résultats au seul champ password.

Voir aussi

add a note add a note

User Contributed Notes 1 note

up
7
dominik at dokdok dot com
9 years ago
There is also a notation to retrieve all fields, but the specified ones

<?php

$users
= $mongo->my_db->users;
$user = $users->findOne(array('username' => 'jwage'), array('password' => 0));
print_r($user);

?>

Will return all fields of the user, but the password field.
To Top