Documentation du code de SPIP et ses plugins

Territoires

Documentation

Packages

SPIP
Application

Table of Contents

_TERRITOIRE_COEFF_MAX_DISTANT  = 8
Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.
_TERRITOIRE_TIME_OUT_PEUPLEMENT  = 20
Time-out par défaut du traitement de peuplement asynchrone.
_TERRITOIRE_URL_BASE_ISOCODE  = 'https://contrib.spip.net/http.api/ezrest'
Endpoint de l'API REST hébergeant les données de Nomenclatures.
action_peupler_territoires_dist()  : void
Cette action permet peupler certains ensembles de territoires contenant un nombre important d'éléments.
territoires_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des alias de tables et filtres automatiques de champs.
territoires_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclaration des objets éditoriaux.
territoires_declarer_tables_auxiliaires()  : array<string|int, mixed>
Déclaration des tables secondaires (liaisons).
territoires_cache_configurer()  : array<string|int, mixed>
Renvoie la configuration spécifique des caches de Rainette.
formulaires_editer_territoire_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
formulaires_editer_territoire_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition de territoire
formulaires_editer_territoire_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire d'édition de territoire
formulaires_editer_territoire_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'édition de territoire
formulaires_peupler_territoires_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose les actions possibles sur les territoires, à savoir, charger ou vider.
formulaires_peupler_territoires_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`depeupler` ou `peupler`) et au moins un territoire.
formulaires_peupler_territoires_traiter()  : array<string|int, mixed>
Exécution du formulaire : les territoires choisis sont soit vidés, soit chargés.
formulaires_peupler_territoires_notifier()  : array<string|int, mixed>
Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des territoires.
inc_requeter_isocode_dist()  : array<string|int, mixed>
Renvoie, à partir de l'url du service, le tableau des données demandées.
territoire_peupler()  : array<string|int, mixed>
Peuple soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
territoire_peupler_asynchrone()  : array<string|int, mixed>
Appelle la fonction de peuplement de territoires en asynchrone.
territoire_depeupler()  : array<string|int, mixed>
Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
territoire_est_peuple()  : bool
Teste si un type de territoire est chargé en base.
territoire_extra_est_peuple()  : bool
Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.
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.
territoires_upgrade()  : void
Fonction d'installation et de mise à jour du plugin Territoires.
territoires_vider_tables()  : void
Fonction de désinstallation du plugin Territoires.
adapter_config_statique()  : void
Fonction de mise à jour de la config statique du plugin.
territoires_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_territoires_menu_dist()  : bool
Autorisation de voir un élément de menu (territoires)
autoriser_territoires_voir_dist()  : bool
Autorisation de voir (territoires)
autoriser_territoires_configurer_dist()  : bool
Autorisation de configurer (territoires)
autoriser_territoires_peupler_dist()  : bool
Autorisation de peupler ou dépeupler des territoires.
autoriser_territoire_voir_dist()  : bool
Autorisation de voir (territoire)
autoriser_territoire_creer_dist()  : bool
Autorisation de créer (territoire)
autoriser_territoire_modifier_dist()  : bool
Autorisation de modifier (territoire)
autoriser_territoire_supprimer_dist()  : bool
Autorisation de supprimer (territoire)
autoriser_associerterritoires_dist()  : bool
Autorisation de lier/délier l'élément (territoires)
territoire_informer_ascendance()  : array<string|int, mixed>
Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.
territoire_lister_type()  : array<string|int, mixed>
Fournit la liste des types de territoire en base de données.
territoire_lister_pays()  : array<string|int, mixed>
Fournit la liste des pays possédant des subdivisisions ou des infrasubdivisions en base de données.
territoire_lister_categorie()  : array<string|int, mixed>
Fournit la liste des catégories de territoire filtrée sur le type et/ou sur le pays.
territoire_extra_informer()  : string|array<string|int, mixed>
Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.
balise_TERRITOIRE_EXTRAS_dist()  : Champ
Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné.
territoires_affiche_milieu()  : array<string|int, mixed>
Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets.
territoires_affiche_gauche()  : array<string|int, mixed>
Ajout de contenu dans la colonne « gauche » des pages de l’espace privé, notamment « la fiche objet » Territoires ajoute le bloc des codes alternatifs.
territoires_exclure_id_conditionnel()  : array<string|int, mixed>
Enlever l'id_territoire de la liste des critères conditionnels pour la table `spip_territoires` car cela peut renvoyer une liste vide si l'env contient déjà l'id du territoire.
territoires_pre_edition()  : array<string|int, mixed>
Complète l'action `modifier` d'un territoire avant modification: - en positionnant l'indicateur d'édition à `oui`afin que les modifications manuelles soient préservées lors d'un prochain rechargement.
territoires_optimiser_base_disparus()  : array<string|int, mixed>
Optimiser la base de données Supprime les liens orphelins de l'objet vers quelqu'un et de quelqu'un vers l'objet.

Constants

_TERRITOIRE_COEFF_MAX_DISTANT

Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.

public mixed _TERRITOIRE_COEFF_MAX_DISTANT = 8

_TERRITOIRE_TIME_OUT_PEUPLEMENT

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

public mixed _TERRITOIRE_TIME_OUT_PEUPLEMENT = 20

_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

action_peupler_territoires_dist()

Cette action permet peupler certains ensembles de territoires contenant un nombre important d'éléments.

action_peupler_territoires_dist() : void

Elle est appelée par l'API territoire_peupler_asynchrone().

Elle ne nécessite les mêmes arguments que la fonction de peuplement.

Return values
void

territoires_declarer_tables_interfaces()

Déclaration des alias de tables et filtres automatiques de champs.

territoires_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Déclarations d'interface pour le compilateur

territoires_declarer_tables_objets_sql()

Déclaration des objets éditoriaux.

territoires_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin Territoires déclare 1 nouvelle table objet, spip_territoires.

Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Description complétée des tables

territoires_declarer_tables_auxiliaires()

Déclaration des tables secondaires (liaisons).

territoires_declarer_tables_auxiliaires(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin Territoires déclare 2 nouvelle tables auxilliaire:

  • celle des liens, spip_territoires_liens
  • celle des caractéristiques complémentaires, spip_territoires_extras
Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_auxiliaires

Return values
array<string|int, mixed>

Description complétée des tables

territoires_cache_configurer()

Renvoie la configuration spécifique des caches de Rainette.

territoires_cache_configurer(string $plugin) : array<string|int, mixed>
Parameters
$plugin : string

Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.

Return values
array<string|int, mixed>

Tableau de la configuration des types de cache du plugin.

formulaires_editer_territoire_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité

formulaires_editer_territoire_identifier_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : string
Parameters
$id_territoire : int|string = 'new'

Identifiant du territoire. 'new' pour un nouveau territoire.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un territoire source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du territoire, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string

Hash du formulaire

formulaires_editer_territoire_charger_dist()

Chargement du formulaire d'édition de territoire

formulaires_editer_territoire_charger_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$id_territoire : int|string = 'new'

Identifiant du territoire. 'new' pour un nouveau territoire.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un territoire source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du territoire, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_charger()
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_editer_territoire_verifier_dist()

Vérifications du formulaire d'édition de territoire

formulaires_editer_territoire_verifier_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs

Parameters
$id_territoire : int|string = 'new'

Identifiant du territoire. 'new' pour un nouveau territoire.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un territoire source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du territoire, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_verifier()
Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_editer_territoire_traiter_dist()

Traitement du formulaire d'édition de territoire

formulaires_editer_territoire_traiter_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Traiter les champs postés

Parameters
$id_territoire : int|string = 'new'

Identifiant du territoire. 'new' pour un nouveau territoire.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un territoire source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL du territoire, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_traiter()
Return values
array<string|int, mixed>

Retours des traitements

formulaires_peupler_territoires_charger()

Chargement des données : le formulaire propose les actions possibles sur les territoires, à savoir, charger ou vider.

formulaires_peupler_territoires_charger() : array<string|int, mixed>
Tags
uses
territoires_acquerir()
uses
territoire_est_peuple()
Return values
array<string|int, mixed>

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro.

  • _actions_peuplement: (affichage) alias et libellés des actions possibles, peupler et depeupler
  • _actions_disable : (affichage) liste des actions désactivées (depeupler si aucun pays n`est chargé)
  • _action_defaut : (affichage) action sélectionnée par défaut, peupler
  • _types : (affichage) types region et pays.
  • _pays : (affichage) pays avec leur code et leur nom ISO dont les subdivisions sont disponibles.

formulaires_peupler_territoires_verifier()

Vérification des saisies : il est indispensable de choisir une action (`depeupler` ou `peupler`) et au moins un territoire.

formulaires_peupler_territoires_verifier() : array<string|int, mixed>
Return values
array<string|int, mixed>

Tableau des erreurs sur l'action et/ou le pays ou tableau vide si aucune erreur.

formulaires_peupler_territoires_traiter()

Exécution du formulaire : les territoires choisis sont soit vidés, soit chargés.

formulaires_peupler_territoires_traiter() : array<string|int, mixed>
Tags
uses
territoire_est_peuple()
uses
territoire_peupler()
uses
territoire_depeupler()
uses
formulaires_peupler_territoires_notifier()
Return values
array<string|int, mixed>

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

formulaires_peupler_territoires_notifier()

Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des territoires.

formulaires_peupler_territoires_notifier(string $type, array<string|int, mixed> $messages, string $action, array<string|int, mixed> $statuts) : array<string|int, mixed>
Parameters
$type : string

Type de territoire.

$messages : array<string|int, mixed>

Tableau des messages ok et nok à compléter.

$action : string

Action venant d'être appliquée à certains pays. Peut prendre les valeurs peupler et depeupler.

$statuts : array<string|int, mixed>

Tableau résultant de l'action sur le type choisi. Peut-êre un tableau de statut pour les subdivisions (plusieurs pays).

  • ok : true si l'action ou la lancement du job a complètement réussi, false sinon (au moins une erreur).
  • sha : indique une sha identique donc pas chargement effectué.
  • arg : indique que le couple (type, pays) eest invalide (pas possible avec le formulaire).
  • type : type de territoire.
  • pays : code ISO alpha2 du pays si le type est subdivision.
  • sync : indique si le peuplement est synchrone ou asynchrone
  • job : id du job si asynchrone
Return values
array<string|int, mixed>

Tableau des messages à afficher sur le formulaire:

  • message_ok : message sur les types ayant été traités avec succès ou vide sinon.
  • message_erreur : message sur les types en erreur ou vide sinon.

inc_requeter_isocode_dist()

Renvoie, à partir de l'url du service, le tableau des données demandées.

inc_requeter_isocode_dist(mixed $url_base, mixed $collection, mixed $filtres[, null|int $taille_max = null ]) : array<string|int, mixed>

Le service utilise dans ce cas une chaine JSON qui est décodée pour fournir le tableau de sortie. Le flux retourné par le service est systématiquement transcodé dans le charset du site avant d'être décodé.

Parameters
$url_base : mixed

Endpoint du serveur Nomenclatures

$collection : mixed

Nom de la collection

$filtres : mixed

Tableau des filtres à appliquer à la collection

$taille_max : null|int = null

Taille maximale du flux récupéré suite à la requête. null désigne la taille par défaut.

Tags
uses
recuperer_url()
Return values
array<string|int, mixed>

Tableau de la réponse. Si l'index erreur est présent c'est que la requête s'est mal dérouléeet la valeur retournée est une chaine qui identifie l'erreur. Sinon, l'index page du flux reçu est retourné après décodage JSON.

territoire_peupler()

Peuple soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.

territoire_peupler(string $type, string $pays[, array<string|int, mixed> $options = array() ]) : 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 : string

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

$options : array<string|int, mixed> = array()

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 et info pour le caractéristiques (table spip_territoires_extras)
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).

territoire_peupler_asynchrone()

Appelle la fonction de peuplement de territoires en asynchrone.

territoire_peupler_asynchrone(string $type, string $pays[, array<string|int, mixed> $options = array() ]) : 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 : array<string|int, mixed> = array()

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 et info pour le caractéristiques (table spip_territoires_extras)
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).

territoire_depeupler()

Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.

territoire_depeupler(string $type[, string $pays = '' ][, array<string|int, mixed> $options = array() ]) : 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 : array<string|int, mixed> = array()

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).

territoire_est_peuple()

Teste si un type de territoire est chargé en base.

territoire_est_peuple(string $type[, array<string|int, mixed>|string $pays = '' ]) : bool

La fonction lit la meta de chargement et non la table spip_territoires.

Parameters
$type : string

Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.

$pays : array<string|int, mixed>|string = ''

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

Return values
bool

true si le territoire est chargé, false sinon.

territoire_extra_est_peuple()

Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.

territoire_extra_est_peuple(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 les valeurs code ou info.

Return values
bool

true si le territoire est chargé, false sinon.

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[, 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 : string = ''

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

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 $meta, string $consigne) : bool
Parameters
$sha : string

SHA à comparer à celui du type de territoire.

$meta : string

Nom de la meta de consignation

$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

territoires_upgrade()

Fonction d'installation et de mise à jour du plugin Territoires.

territoires_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

Return values
void

territoires_vider_tables()

Fonction de désinstallation du plugin Territoires.

territoires_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

Return values
void

adapter_config_statique()

Fonction de mise à jour de la config statique du plugin.

adapter_config_statique(array<string|int, mixed> $config_statique) : void
Parameters
$config_statique : array<string|int, mixed>

Nouvelle configuration statique

Return values
void

territoires_autoriser()

Fonction d'appel pour le pipeline

territoires_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_territoires_menu_dist()

Autorisation de voir un élément de menu (territoires)

autoriser_territoires_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoires_voir_dist()

Autorisation de voir (territoires)

autoriser_territoires_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoires_configurer_dist()

Autorisation de configurer (territoires)

autoriser_territoires_configurer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoires_peupler_dist()

Autorisation de peupler ou dépeupler des territoires.

autoriser_territoires_peupler_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoire_voir_dist()

Autorisation de voir (territoire)

autoriser_territoire_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoire_creer_dist()

Autorisation de créer (territoire)

autoriser_territoire_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoire_modifier_dist()

Autorisation de modifier (territoire)

autoriser_territoire_modifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_territoire_supprimer_dist()

Autorisation de supprimer (territoire)

autoriser_territoire_supprimer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_associerterritoires_dist()

Autorisation de lier/délier l'élément (territoires)

autoriser_associerterritoires_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

territoire_informer_ascendance()

Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.

territoire_informer_ascendance(string $iso_territoire[, string|null $iso_parent = null ][, string $ordre = 'descendant' ]) : array<string|int, mixed>
Parameters
$iso_territoire : string

Code ISO principal du territoire

$iso_parent : string|null = null

Code ISO principal du parent direct du territoire concerné ou chaine vide sinon

$ordre : string = 'descendant'

Classement de la liste : descendant(défaut) ou ascendant.

Tags
filtre
Return values
array<string|int, mixed>

Liste des territoires ascendants.

territoire_lister_type()

Fournit la liste des types de territoire en base de données.

territoire_lister_type() : array<string|int, mixed>
Tags
filtre
Return values
array<string|int, mixed>

Liste des types de territoires sous la forme [type] = libellé du type.

territoire_lister_pays()

Fournit la liste des pays possédant des subdivisisions ou des infrasubdivisions en base de données.

territoire_lister_pays([string $type = '' ][, string $categorie = '' ]) : array<string|int, mixed>

Il est aussi possible de renvoyer la liste des pays si ceux-ci sont aussi présents.

Parameters
$type : string = ''

Type de territoires. Prends les valeurs country, subdivision ou infrasubdivision. La valeur par défaut est country.

$categorie : string = ''

Catégorie de territoire.

Tags
filtre
Return values
array<string|int, mixed>

Liste des pays sous la forme [iso_pays] = nom usuel.

territoire_lister_categorie()

Fournit la liste des catégories de territoire filtrée sur le type et/ou sur le pays.

territoire_lister_categorie([string $type = '' ][, string $pays = '' ]) : array<string|int, mixed>
Parameters
$type : string = ''

Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision ou chaine vide pour ne pas tenir compte du type.

$pays : string = ''

Code ISO 3166-1 alpha2 du pays sinon une chaine vide.

Tags
filtre
Return values
array<string|int, mixed>

Liste des identifiants de catégorie.

territoire_extra_informer()

Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.

territoire_extra_informer(string $iso_territoire[, string $information = '' ]) : string|array<string|int, mixed>

Cette fonction ne renvoie pas les champs du territoire lui-même (table spip_territoires).

Parameters
$iso_territoire : string

Code ISO principal du territoire

$information : string = ''

Type d'information à renvoyer depuis la table spip_territoires_extras ou vide si on veut toutes les informations.

Tags
filtre
Return values
string|array<string|int, mixed>

Information ou liste des informations.

balise_TERRITOIRE_EXTRAS_dist()

Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné.

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
balise
uses
territoire_extra_informer()
Return values
Champ

Pile complétée par le code à générer.

territoires_affiche_milieu()

Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets.

territoires_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>

Territoires ajoute les éventuels caractéristiques complémentaires et le formulaire d'association.

Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed>

Données du pipeline modifiées pour refléter le traitement.

territoires_affiche_gauche()

Ajout de contenu dans la colonne « gauche » des pages de l’espace privé, notamment « la fiche objet » Territoires ajoute le bloc des codes alternatifs.

territoires_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_gauche

Return values
array<string|int, mixed>

Données du pipeline modifiées pour refléter le traitement.

territoires_exclure_id_conditionnel()

Enlever l'id_territoire de la liste des critères conditionnels pour la table `spip_territoires` car cela peut renvoyer une liste vide si l'env contient déjà l'id du territoire.

territoires_exclure_id_conditionnel(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Return values
array<string|int, mixed>

Données du pipeline modifiées pour refléter le traitement.

territoires_pre_edition()

Complète l'action `modifier` d'un territoire avant modification: - en positionnant l'indicateur d'édition à `oui`afin que les modifications manuelles soient préservées lors d'un prochain rechargement.

territoires_pre_edition(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).

Tags
pipeline

pre_edition

Return values
array<string|int, mixed>

Données du pipeline modifiées pour refléter le traitement.

territoires_optimiser_base_disparus()

Optimiser la base de données Supprime les liens orphelins de l'objet vers quelqu'un et de quelqu'un vers l'objet.

territoires_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

optimiser_base_disparus

Return values
array<string|int, mixed>

Données du pipeline modifiées pour refléter le traitement.

Search results