13.13.17 SearchDoc::count()

13.13.17.1 Description

int count ( )

13.13.17.1.1 Avertissements

La fonction SearchDoc::search doit être exécutée avant la méthode ::count() sinon le résultat retourné est -1. Si le but est simplement de compter le nombre de résultats, il est préférable d'utiliser onlyCount qui est optimisé pour faire uniquement le décompte et ne nécessite pas de récupérer le résultat de la recherche.

Si des nouveaux critères sont ajoutés après l'exécution de la fonction SearchDoc::search, il faut effectuer de nouveau la fonction SearchDoc::search pour que la méthode ::count() prenne en compte les nouveaux critères.

13.13.17.2 Liste des paramètres

Aucun.

13.13.17.3 Valeur de retour

Deux cas :

• soit un entier représentant le nombre de résultat,
• si la fonction SearchDoc::search n'a pas été exécutée -1.

13.13.17.4 Erreurs / Exceptions

Aucune.

13.13.17.5 Historique

13.13.17.5.1 Release 3.2.12

3.2.12 Si count() est appelé avant search(), le résultat est -1. Il était auparavant égal à 0.

Le résultat du count() n'était pas réinitialisé en cas de recherches successives si le type de retour était "objet documentaire". Il fallait dans ce cas, appeler la méthode reset() avant l'appel à search().

13.13.17.6 Exemples

Compte le nombre total de documents :

function countAllTheDoc(Action & $action)
{
    header('Content-Type: text/plain');
 
    $searchDoc = new SearchDoc();
    $searchDoc->setObjectReturn(true);
 
    $document = $searchDoc->search();
 
    var_export($searchDoc->count());
}

Note : Si le but est simplement de compter le nombre de résultats, il est préférable d'utiliser onlyCount.

13.13.17.7 Notes

Aucune.

13.13.17.8 Voir aussi

• DocSearch::onlyCount()
• DocSearch::search()