Correction de PHPDoc

v0_spip32
Eric Lupinacci 3 years ago
parent ab072df760
commit 6632d23bab

@ -1,7 +1,7 @@
<?php
/**
* Ce fichier contient les fonctions d'API du plugin Taxonomie utilisées comme filtre dans les squelettes.
* Les autres fonctions de l'API sont dans le fichier `inc/taxonomie`.
* Ce fichier contient les fonctions d'API du plugin Territoires utilisées comme filtre dans les squelettes.
* Les autres fonctions de l'API sont dans le fichier `inc/territoire`.
*
*/
if (!defined('_ECRIRE_INC_VERSION')) {
@ -10,25 +10,18 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Fournit l'ascendance géogrpahique d'un territoire, par consultation dans la base de données.
* Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.
*
* @package SPIP\TERRITOIRE\API
*
* @api
* @filtre
*
* @param string $iso_territoire
* Id du taxon pour lequel il faut fournir l'ascendance.
* @param string $iso_parent
* TSN du parent correspondant au taxon id_taxon. Ce paramètre permet d'optimiser le traitement
* mais n'est pas obligatoire. Si il n'est pas connu lors de l'appel il faut passer `null`.
* @param string $ordre
* Classement de la liste des taxons : `descendant`(défaut) ou `ascendant`.
* @param string $iso_territoire Code ISO principal du territoire
* @param string $iso_parent Code ISO principal du parent direct du territoire concerné ou chaine vide sinon
* @param string $ordre Classement de la liste : `descendant`(défaut) ou `ascendant`.
*
* @return array
* Liste des taxons ascendants. Chaque taxon est un tableau associatif contenant les informations
* suivantes : `id_taxon`, `tsn_parent`, `nom_scientifique`, `nom_commun`, `rang`, `statut` et l'indicateur
* d'espèce `espèce`.
* @return array Liste des territoires ascendants.
*/
function territoire_informer_ascendance($iso_territoire, $iso_parent = null, $ordre = 'descendant') {

Loading…
Cancel
Save