Territoires

unite_peuplement.php

API de gestion des unités de peuplement des territoires, appelable par différents plugins utilisateurs.

Functions

unite_peuplement_serveur_est_compatible() : bool: Vérifie si le serveur configuré pour récupérer les informations sur les territoires est compatible avec le plugin appelant passé en argument.
unite_peuplement_est_chargee() : string: Vérifier si une variable de consignation de peuplement existe.
unite_peuplement_est_obsolete() : bool: Compare le sha passé en argument pour l'unité de peuplement concernée avec le sha stocké dans la meta pour cette même unité.
unite_peuplement_consigne_identifier() : string: Identifie la variable de consignation d'un peuplement.
unite_peuplement_acquerir() : array<string|int, mixed>: Acquiert les données de territoires disponibles dans Nomenclatures.
unite_peuplement_informer_feeds() : array<string|int, mixed>: Liste les feeds fournissant des nomenclatures de territoires pour l'unité de peuplement requise.
unite_peuplement_retablir_liens() : void: Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.

unite_peuplement_serveur_est_compatible()

Vérifie si le serveur configuré pour récupérer les informations sur les territoires est compatible avec le plugin appelant passé en argument.


    
                    unite_peuplement_serveur_est_compatible(string $plugin) : bool

Parameters

$plugin : string: Préfixe du plugin appelant.

Return values

bool —

true si le serveur est compatible avec la version du plugin appelant ou false sinon.

unite_peuplement_est_chargee()

Vérifier si une variable de consignation de peuplement existe.


    
                    unite_peuplement_est_chargee(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Est utilisable pour la nomenclature des territoires et les contours.

Parameters

$plugin : string: Préfixe du plugin appelant.
$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.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

string

unite_peuplement_est_obsolete()

Compare le sha passé en argument pour l'unité de peuplement concernée avec le sha stocké dans la meta pour cette même unité.


    
                    unite_peuplement_est_obsolete(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|array<string|int, mixed> $feeds = [] ]) : bool

Parameters

$plugin : string: Préfixe du plugin appelant.
$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.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.
$feeds : null|array<string|int, mixed> = []: Liste des feeds disponibles pour le type donné.

Return values

bool —

true si le sha passé en argument est identique au sha stocké pour la table choisie, false sinon.

unite_peuplement_consigne_identifier()

Identifie la variable de consignation d'un peuplement.


    
                    unite_peuplement_consigne_identifier(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Est utilisable pour la nomenclature des territoires et les contours.

Parameters

$plugin : string: Préfixe du plugin appelant.
$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.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

string

unite_peuplement_acquerir()

Acquiert les données de territoires disponibles dans Nomenclatures.


    
                    unite_peuplement_acquerir(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

La fonction utilise l'API REST de Nomenclatures.

Parameters

$plugin : string: Préfixe du plugin appelant.
$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.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.
$options : null|array<string|int, mixed> = []: L'option cacher_synchrone à true permet d'utiliser un cache pour limiter les requêtes au serveur et accélérer la fourniture des données. L'option cacher_asynchrone à true permet de mettre la collection récupérée dans un cache temporaire pour être utilisée lors des itérations en mode asynchrone dans une fonction idoine.

Return values

array<string|int, mixed> —

Liste des données de territoires telles que fournies par l'API REST

unite_peuplement_informer_feeds()

Liste les feeds fournissant des nomenclatures de territoires pour l'unité de peuplement requise.


    
                    unite_peuplement_informer_feeds(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|string $information = '' ]) : array<string|int, mixed>

Correspond à la catégorie territory du plugin Nomenclatures.

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer
$information : null|string = '': Information précise à renvoyer seule ou tout si vide. Les valeurs possibles sont feed, pays, hash ou credit.

Return values

array<string|int, mixed> —

Liste des feeds.

unite_peuplement_retablir_liens()

Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.


    
                    unite_peuplement_retablir_liens(string $type_lien, array<string|int, mixed> $sauvegardes, array<string|int, mixed> $ids_crees, array<string|int, mixed> $config_lien) : void

Parameters

$type_lien : string

Type de liens à restaurer : liens, logos ou autre.

$sauvegardes : array<string|int, mixed>

Tableau des sauvegardes dans lequel puiser les liens existants

$ids_crees : array<string|int, mixed>

Tableau des nouveaux id des territoires.

$config_lien : array<string|int, mixed>

Tableau de configuration de la table de liens concernée composé des index:

table : nom complet de la table spip
id_table : nom du champ id du territoire

SPIP Code

Territoires

unite_peuplement.php

Table of Contents

Functions

Functions

unite_peuplement_serveur_est_compatible()

Parameters

Tags

Return values

unite_peuplement_est_chargee()

Parameters

Tags

Return values

unite_peuplement_est_obsolete()

Parameters

Tags

Return values

unite_peuplement_consigne_identifier()

Parameters

Tags

Return values

unite_peuplement_acquerir()

Parameters

Tags

Return values

unite_peuplement_informer_feeds()

Parameters

Tags

Return values

unite_peuplement_retablir_liens()

Parameters

Tags

Search results