13.13.23 SearchDoc::getNextDoc()

Cette méthode permet de d'itérer sur la liste des documents trouvés par la recherche.

13.13.23.1 Description

Doc|array|null getNextDoc()

Cette méthode retourne le document suivant du resultat de la recherche.

13.13.23.1.1 Avertissements

Aucun.

13.13.23.2 Liste des paramètres

Aucun.

13.13.23.3 Valeur de retour

La valeur de retour peut être :

  • array : si le type de recherche n'est pas object,
  • Doc : si le type de recherche est object,
  • null : si tous les documents ont été parcourus.

13.13.23.4 Erreurs / Exceptions

Aucune.

13.13.23.5 Historique

Anciennement nommé SearchDoc::nextDoc().

13.13.23.6 Exemples

13.13.23.6.1 Itération sur les tous les documents :

 
$searchDoc = new searchDoc();
$searchDoc->setObjectReturn(true);
$searchDoc->search();
 
$err = $searchDoc->getError();
if ($err !== "") {
    throw new Exception("Error Processing Search ".$err, 1);
}
 
while($document = $searchDoc->getNextDoc()) {
    print $document->getTitle()."\n";
}
 
var_export($searchDoc->getSearchInfo());

Dans ce cas, les hooks Doc::preAffect() et Doc::postAffect() sont appelés dans la boucle à chaque appel de getNextDoc().

13.13.23.6.2 Récupération du premier dossier

Récupération du premier document "dossier" qui a été créé.

$searchDoc = new searchDoc('', "DIR");
$searchDoc->setSlice(1);
$searchDoc->setOrder('initid');
$searchDoc->setObjectReturn(true);
$searchDoc->search();
 
if (searchDoc->count() > 0) {
    $firstFolder=$searchDoc->getNextDoc();
}

13.13.23.7 Notes

La méthode SearchDoc::getDocumentList permets aussi l'itération des résultats de la recherche.

La méthode SearchDoc::rewind() permet à la méthode SearchDoc::getNextDoc() de revenir au premier document trouvé.

13.13.23.8 Voir aussi

×