SPIP Code

Documentation du code de SPIP et de ses plugins

Taxonomie

wikipedia_api.php

Ce fichier contient l'ensemble des constantes et fonctions implémentant le service web de Wikipedia.

Table of Contents

Constants

_TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT  = 86400 * 30
Période de renouvellement du cache de Wikipedia (30 jours).
_TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL  = 'https://%langue%.wikipedia.org/w/api.php'
Préfixe des URL du service web de WIKIPEDIA.
_TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL  = 'https://%langue%.wikipedia.org/wiki/'
URL de base pour construire une page de Wikipedia dans une langue donnée.

Functions

wikipedia_get_page()  : array<string|int, mixed>
Renvoie, à partir d'une phrase de recherche, soit le texte de la page ou d'une section de la page avec ou pas la liste des autres pages possibles, soit la liste des langues de la page.
wikipedia_find_language()  : string
Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.
wikipedia_credit()  : string
Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

Constants

_TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT

Période de renouvellement du cache de Wikipedia (30 jours).

public mixed _TAXONOMIE_WIKIPEDIA_CACHE_TIMEOUT = 86400 * 30

_TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL

Préfixe des URL du service web de WIKIPEDIA.

public mixed _TAXONOMIE_WIKIPEDIA_ENDPOINT_BASE_URL = 'https://%langue%.wikipedia.org/w/api.php'

_TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL

URL de base pour construire une page de Wikipedia dans une langue donnée.

public mixed _TAXONOMIE_WIKIPEDIA_PAGE_BASE_URL = 'https://%langue%.wikipedia.org/wiki/'

Functions

wikipedia_get_page()

Renvoie, à partir d'une phrase de recherche, soit le texte de la page ou d'une section de la page avec ou pas la liste des autres pages possibles, soit la liste des langues de la page.

wikipedia_get_page(array<string|int, mixed> $search, string $spip_language[, null|int $section = null ][, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Cette phrase de recherche est toujours le nom scientifique du taxon dans l'utilisation qui en est faite par le plugin Taxonomie. Le résultat de la requête est mis en cache pour une durée de plusieurs jours afin d'être servi à nouveau sans accès à Wikipedia.

Parameters
$search : array<string|int, mixed>

Tableau contenant le taxon à cherché sous une forme textuelle et numérique:

  • name : chaine de recherche qui est en généralement le nom scientifique du taxon.
  • tsn : identifiant ITIS du taxon, le TSN. Etant donné que ce service s'utilise toujours sur un taxon existant le TSN existe toujours. Il sert à créer le fichier cache.
$spip_language : string

Code de langue SPIP dans lequel on souhaite récupérer la page Wikipedia.

$section : null|int = null

Section de page dont le texte est à renvoyer. Entier supérieur ou égal à 0 ou null pour tout la page.

$options : null|array<string|int, mixed> = []

Tableau d'options qui peut contenir les index suivants :

  • reload : force le recalcul du cache. Cet argument est optionnel.
Tags
uses
cache_est_valide()
uses
wikipedia_build_url()
uses
inc_taxonomie_requeter()
uses
cache_ecrire()
uses
cache_lire()
used-by
formulaires_decrire_taxon_charger()
used-by
formulaires_decrire_taxon_verifier_1()
used-by
formulaires_decrire_taxon_traiter()
used-by
formulaires_nommer_taxon_traiter()
Return values
array<string|int, mixed> —

Texte trouvé rédigé en mediawiki ou chaine vide sinon. Pour traduire le texte en SPIP il est nécessaire d'utiliser le plugin Convertisseur. Néanmoins, le texte même traduit doit être remanié manuellement.

wikipedia_find_language()

Renvoie la langue telle que le service Wikipedia la désigne à partir du code de langue de SPIP.

wikipedia_find_language(string $spip_language) : string
Parameters
$spip_language : string

Code de langue de SPIP. Prend les valeurs fr, en, es, etc. La variable globale $wikipedia_language définit le transcodage langue Wikipedia vers code SPIP.

Return values
string —

Langue au sens de Wikipedia - fr, en, es - ou chaine vide sinon.

wikipedia_credit()

Construit la phrase de crédits précisant que les données fournies proviennent d'une page de Wikipedia.

wikipedia_credit(int $id_taxon, array<string|int, mixed> $informations) : string
Parameters
$id_taxon : int

Id du taxon nécessaire pour construire l'url de la page Wikipedia concernée.

$informations : array<string|int, mixed>

Tableau des informations complémentaires sur la source. Pour Wikipedia ce tableau fourni le ou les champs remplis avec Wikipedia.

Return values
string —

Phrase de crédit.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results