... | ... | @@ -77,10 +77,13 @@ Scrutari.Client.init(scrutariConfig, "scrutariCol", { |
|
|
|
|
|
on notera que la variable **this** fait référence dans la fonction à l'objet *client* en cours. Les autres arguments diffèrent suivant les points d'entrée.
|
|
|
|
|
|
Certains points d'entrée doivent retourner une valeur, d'autres non.
|
|
|
|
|
|
Les points d'entrée disponibles sont les suivants :
|
|
|
|
|
|
* **getTemplate** : appelé au moment de l'appel d'un gabarit (fonction Scrutari.Client.prototype.getTemplate), avec comme argument *templateName*, le nom du gabarit. Si le point d'entrée renvoie une fonction, elle remplace le gabarit par défaut
|
|
|
* **getFicheBodyTemplateArray** : appelé au moment de la récupération du tableau des gabarits du corps d'une fiche. Arguments : *fiche* (Objet ficheen question), *categoryName* (nom de la catégorie de la fiche)
|
|
|
* **showResult** : appelé à la fin de l'affichage des résultats (fonction Scrutari.Client.Result.show) , permet d'afficher des éléments supplémentaires. Arguments : *scrutariResult* (l'instance de Scrutari.Result avec le résultat), *searchOrigin* (origine de la recherche, vaut *mainsearch* ou *subsearch*)
|
|
|
* **completeFiche** : appelé à la fin de l'enrichissement d'un objet *fiche* (fonction Scrutari.Client.Result.completeFiche), permet de personnaliser les ajouts. Arguments : *scrutariResult* (l'instance de Scrutari.Result avec le résultat), *fiche* (Objet fiche à enrichir), *categoryName* (nom de la catégorie de la fiche)
|
|
|
* **paginationChange**: appelé après un changement de pagination (fonctions Scrutari.Client.Result.uniquePaginationChange et Scrutari.Client.Result.categoryPaginationChange). Arguments : *paginationFicheArray* (tableau des nouvelles fiches dans la pagination), *options* (objet d'options) |
|
|
\ No newline at end of file |
|
|
* **completeFiche** : appelé juste avant l'appel d'une nouvelle recherche Scrutari.Result.newSearch. Arguments : *requestParameters* (le tableau des paramètres argument de Scrutari.Result.newSearch), *searchOrigin* (origine de la recherche, vaut *mainsearch*, *qidsearch* (Recherche lancée à l'initialisation sur la base d'un Qid) ou *subsearch*). Aucune valeur de retour n'est attendue, ce point d'entrée sert à modifier l'objet *requestParameters* (ajout de paramètres, supplémentaires par exemple)
|
|
|
* **getTemplate** : appelé au moment de l'appel d'un gabarit (fonction Scrutari.Client.prototype.getTemplate), avec comme argument *templateName*, le nom du gabarit. Doit retourner une fonction qui remplace le gabarit par défaut. Si rien n'est retourné, le gabarit par défaut est utilié
|
|
|
* **getFicheBodyTemplateArray** : appelé au moment de la récupération du tableau des gabarits du corps d'une fiche (fonction Scrutari.Client.prototype.getFicheBodyTemplateArray). Arguments : *fiche* (Objet fiche en question), *categoryName* (nom de la catégorie de la fiche). Doit retourner un tableau des gabarits à utiliser pour l'affichage de la fiche. Si rien n'est retourné, c'est le tableau par défaut qui et utilisé
|
|
|
* **showResult** : appelé à la fin de l'affichage des résultats (fonction Scrutari.Client.Result.show). Arguments : *scrutariResult* (l'instance de Scrutari.Result avec le résultat), *searchOrigin* (origine de la recherche, vaut *mainsearch* ou *subsearch*). Aucune valeur de retour n'est attendue, ce point d'entrée est utilisé pour afficher des éléments supplémentaires sur la base de scrutariResult.
|
|
|
* **completeFiche** : appelé à la fin de l'enrichissement d'un objet *fiche* (fonction Scrutari.Client.Result.completeFiche), permet de personnaliser les ajouts. Arguments : *scrutariResult* (l'instance de Scrutari.Result avec le résultat), *fiche* (Objet fiche à enrichir), *categoryName* (nom de la catégorie de la fiche). Aucune valeur de retour n'est attendue, ce point d'entrée est utilisé pour modifier l'objet fiche à sa guise avant son affichage.
|
|
|
* **paginationChange**: appelé après un changement de pagination (fonctions Scrutari.Client.Result.uniquePaginationChange et Scrutari.Client.Result.categoryPaginationChange). Arguments : *paginationFicheArray* (tableau des nouvelles fiches dans la pagination), *options* (objet d'options). Aucune valeur de retour n'est attendue. |
|
|
\ No newline at end of file |