MongoGridFS::delete

(PECL mongo >=1.0.8)

MongoGridFS::delete — Efface un fichier et ces morceaux depuis la base de données

Description

public MongoGridFS::delete ( mixed $id ) : bool|array

Note:
La méthode MongoGridFS::delete() est une méthode de convenance pour l'appel à la méthode MongoGridFS::remove() avec des critères criteria spécifiques et des paramètres options par défaut.

Liste de paramètres

id: Champ _id du fichier à effacer.

Valeurs de retour

Retourne un tableau contenant le statut de la suppression (avec le respect de la collection files) si une considération d'écriture est appliquée. Sinon, retourne TRUE.

Les champs du tableau des statuts sont décrits dans la document pour la méthode MongoCollection::insert().

Erreurs / Exceptions

Lance une exception MongoCursorException si l'option "w" est définie, et que l'écriture échoue.

Lance une exception MongoCursorTimeoutException si l'option "w" est définie à une valeur supérieure à 1 et que l'opération prend plus de temps que MongoCursor::$timeout millisecondes à se terminer. Ceci ne va pas mettre fin à l'opération sur le serveur, ce n'est qu'un délai d'attente maximal côté client. L'unité pour MongoCollection::$wtimeout est la milliseconde.

add a note

User Contributed Notes 1 note

down

-1

mshallop+php-at-gmail-dot-com ¶

10 years ago


Doc doesn't explicitly state what is returned. 

Returns an array:

{ 
  n => {integer value}  (number of records deleted),
  connectionID => { integer value }
  err => null or error text/code
  ok => 1 or 0 
}

Sample output:

{ n : 1, connectionID : 33132, err : null, ok : 1 }

add a note