API
Table of Contents
Packages
Constants
- _TERRITOIRE_TIME_OUT_PEUPLEMENT = 20
- Time-out par défaut du traitement de peuplement asynchrone.
Functions
- unite_peuplement_charger() : array<string|int, mixed>
- Peuple soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
- unite_peuplement_charger_asynchrone() : array<string|int, mixed>
- Appelle la fonction de peuplement de territoires en asynchrone.
- unite_peuplement_vider() : array<string|int, mixed>
- Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
- unite_peuplement_extra_est_charge() : bool
- Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.
- balise_TERRITOIRE_ASCENDANCE_dist() : Champ
- Compile la balise `#TERRITOIRE_ASCENDANCE` qui renvoie l'ascendance d'un territoire donné désigne par son identifiant primaire.
- balise_TERRITOIRE_EXTRAS_dist() : Champ
- Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné désigne par son identifiant primaire.
Constants
_TERRITOIRE_TIME_OUT_PEUPLEMENT
Time-out par défaut du traitement de peuplement asynchrone.
public
mixed
_TERRITOIRE_TIME_OUT_PEUPLEMENT
= 20
Functions
unite_peuplement_charger()
Peuple soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
unite_peuplement_charger(string $type, null|string $pays[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
La fonction utilise les données fournies par Nomenclatures.
Parameters
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivisionouinfrasubdivision. - $pays : null|string
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $options : null|array<string|int, mixed> = []
-
Tableau des options de peuplement:
-
force: sitrueforce le repeuplement même si le sha est identique (falsepar défaut). -
extras: tableau des types d'extras à peupler soitcodepour les codes alternatifs etinfopour le caractéristiques (table spip_territoires_extras)
-
Tags
Return values
array<string|int, mixed> —Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).
unite_peuplement_charger_asynchrone()
Appelle la fonction de peuplement de territoires en asynchrone.
unite_peuplement_charger_asynchrone(string $type, string $pays[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivisionouinfrasubdivision. - $pays : string
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $options : null|array<string|int, mixed> = []
-
Tableau des options de peuplement:
-
force: sitrueforce le repeuplement même si le sha est identique (falsepar défaut). -
extras: tableau des types d'extras à peupler soitcodepour les codes alternatifs etinfopour le caractéristiques (table spip_territoires_extras)
-
Tags
Return values
array<string|int, mixed> —Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).
unite_peuplement_vider()
Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
unite_peuplement_vider(string $type[, null|string $pays = '' ][, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivisionouinfrasubdivision. - $pays : null|string = ''
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $options : null|array<string|int, mixed> = []
-
Tableau des options de dépeuplement:
-
force: sitrueforce le vidage même si la meta n'est pas présente (cas d'erreur sur timeout par exemple). La valeur par défaut estfalse.
-
Tags
Return values
array<string|int, mixed> —Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).
unite_peuplement_extra_est_charge()
Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.
unite_peuplement_extra_est_charge(string $type, string $pays, string $type_extra) : bool
La fonction lit la meta de chargement et non la table spip_territoires_extras.
Parameters
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivisionouinfrasubdivision. - $pays : string
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $type_extra : string
-
Type d'extra. Prends les valeurs
codeouinfo.
Tags
Return values
bool —true si le territoire est chargé, false sinon.
balise_TERRITOIRE_ASCENDANCE_dist()
Compile la balise `#TERRITOIRE_ASCENDANCE` qui renvoie l'ascendance d'un territoire donné désigne par son identifiant primaire.
balise_TERRITOIRE_ASCENDANCE_dist(Champ $p) : Champ
La signature de la balise est : #TERRITOIRE_ASCENDANCE{iso_territoire[, parent, ordre]}.
Parameters
- $p : Champ
-
Pile au niveau de la balise.
Tags
Return values
Champ —Pile complétée par le code à générer.
balise_TERRITOIRE_EXTRAS_dist()
Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné désigne par son identifiant primaire.
balise_TERRITOIRE_EXTRAS_dist(Champ $p) : Champ
La signature de la balise est : #TERRITOIRE_EXTRAS{iso_territoire[, information]}.
Parameters
- $p : Champ
-
Pile au niveau de la balise.
Tags
Return values
Champ —Pile complétée par le code à générer.