SPIP Code

Documentation du code de SPIP et de ses plugins

Territoires

territoires_services.php

API des services de territoires utilisables par d'autres plugins.

Table of Contents

_TERRITOIRE_URL_BASE_ISOCODE  = 'https://contrib.spip.net/http.api/ezrest'
Endpoint de l'API REST hébergeant les données de Nomenclatures.
feeds_acquerir()  : array<string|int, mixed>
Liste les feeds fournissant des nomenclatures de territoires.
type_pays_est_valide()  : bool
Vérifie si le couple (type, pays) est valide, à savoir, désigne bien un sous-ensemble cohérent de territoires.
sha_est_identique()  : bool
Compare le sha passé en argument pour le type de territoire concerné avec le sha stocké dans la meta pour ce même type.
liens_retablir()  : void
Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.

Constants

_TERRITOIRE_URL_BASE_ISOCODE

Endpoint de l'API REST hébergeant les données de Nomenclatures.

public mixed _TERRITOIRE_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest'

Functions

feeds_acquerir()

Liste les feeds fournissant des nomenclatures de territoires.

feeds_acquerir(array<string|int, mixed> $categories_feed) : array<string|int, mixed>
Parameters
$categories_feed : array<string|int, mixed>

Liste des catégories de feeds à acquérir.

Return values
array<string|int, mixed> —

Liste des feeds.

type_pays_est_valide()

Vérifie si le couple (type, pays) est valide, à savoir, désigne bien un sous-ensemble cohérent de territoires.

type_pays_est_valide(string $type[, null|string $pays = '' ]) : bool

Les sous-ensembles valides sont :

  • les régions du monde
  • les pays
  • les subdivisions ou infra-subdivisions d'un pays.
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.

Tags
uses
type_est_subdivision()
Return values
bool —

true si le couple (type, pays) est valide, false sinon.

sha_est_identique()

Compare le sha passé en argument pour le type de territoire concerné avec le sha stocké dans la meta pour ce même type.

sha_est_identique(string $sha, string $id_consigne) : bool
Parameters
$sha : string

SHA à comparer à celui du type de territoire.

$id_consigne : string

Nom de la variable de consignation, fonction du type et du pays éventuellement.

Return values
bool —

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

liens_retablir()

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

liens_retablir(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 ou logos.

$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
Return values
void —

Search results