Territoires

territoires_unite_peuplement.php

Complément spécifique de l'API de gestion des unités de peuplement des territoires.

Concerne uniquement les données de nomenclatures et les informations additionnelles sur les territoires.

Constants

_TERRITOIRES_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, au sens large, 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.

_TERRITOIRES_TIME_OUT_PEUPLEMENT

Time-out par défaut du traitement de peuplement asynchrone.


    public
        mixed
    _TERRITOIRES_TIME_OUT_PEUPLEMENT
    = 20

unite_peuplement_charger()

Peuple soit les régions du monde, soit les pays ou soit les subdivisions, au sens large, 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, subdivision ou infrasubdivision.

$pays : null|string

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

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

Tableau des options de peuplement:

force : si true force le repeuplement même si le sha est identique (false par défaut).
extras: tableau des types d'extras à peupler soit code pour les codes alternatifs mais d'autres valeurs sont possibles (plugins complémentaires)

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, subdivision ou infrasubdivision.

$pays : string

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

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

Tableau des options de peuplement:

force : si true force le repeuplement même si le sha est identique (false par défaut).
extras: tableau des types d'extras à peupler soit code pour les codes alternatifs mais d'autres valeurs sont possibles (plugins complémentaires)

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, subdivision ou infrasubdivision.

$pays : null|string = ''

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

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

Tableau des options de dépeuplement:

force : si true force le vidage même si la meta n'est pas présente (cas d'erreur sur timeout par exemple). La valeur par défaut est false.

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, subdivision ou infrasubdivision.
$pays : string: Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$type_extra : string: Type d'extra. Prends la valeur code uniquement pour Territoires mais d'autres valeurs possibles via des plugins complémentaires.

Return values

bool —

true si le territoire est chargé, false sinon.

SPIP Code

Territoires

territoires_unite_peuplement.php

Table of Contents

Constants

Functions

Constants

_TERRITOIRES_TIME_OUT_PEUPLEMENT

Functions

unite_peuplement_charger()

Parameters

Tags

Return values

unite_peuplement_charger_asynchrone()

Parameters

Tags

Return values

unite_peuplement_vider()

Parameters

Tags

Return values

unite_peuplement_extra_est_charge()

Parameters

Tags

Return values

Search results