13.13.18 SearchDoc::getDocumentList()

13.13.18.1 Description

DocumentList getDocumentList ( )

13.13.18.1.1 Avertissements

L'exécution de la méthode SearchDoc::search n'est pas nécessaire avant l'utilisation de ::getDocumentList(). Si cette méthode est appelée avant l'itération, elle ne sera pas exécutée lors de l'itération. Dans le cas contraire, la méthode SearchDoc::search sera appelée dès le début de l'itération.

13.13.18.2 Liste des paramètres

Aucun.

13.13.18.3 Valeur de retour

Un objet de type DocumentList.

13.13.18.4 Erreurs / Exceptions

Aucune.

13.13.18.5 Historique

Aucun.

13.13.18.6 Exemples

13.13.18.7 Retour d'objets documentaires

Récupère la liste des documents de la famille "dossiers" :

$s=new SearchDoc("","DIR");
$s->setObjectReturn(true);
$s->search();
 
$documentList=$s->getDocumentList();
 
foreach ($documentList as $docid=>$doc) {
    printf("%d) %s (%s)\n", 
           $docid,
           $doc->getTitle(),
           $doc->getRawValue(\Dcp\AttributeIdentifiers\Dir::ba_desc, "Pas de description"));
}

Résultat :

3590) mimetypes (Pas de description)
1436) Porte-document (porte-documents de Default Master)
9) Racine (Pas de description)

13.13.18.8 Retour de valeurs brutes

Récupère la liste des données des "dossiers" :

$s=new SearchDoc("","DIR");
$s->setObjectReturn(false);
$s->search();
 
$documentList=$s->getDocumentList();
 
foreach ($documentList as $docid=>$doc) {
  printf("%d) %s (%s)\n", 
     $docid,
     $doc["title"],
     empty($doc[\Dcp\AttributeIdentifiers\Dir::ba_desc])
        ?"Pas de description"
        :($doc[\Dcp\AttributeIdentifiers\Dir::ba_desc]));
}

Résultat :

3590) mimetypes (Pas de description)
1436) Porte-document (porte-documents de Default Master)
9) Racine (Pas de description)

13.13.18.9 Notes

Aucun.

13.13.18.10 Voir aussi

• Classe DocumentList,
• Recherche avancée.