Documentation du code de SPIP et de ses plugins

Nomenclatures officielles

Documentation

Packages

SPIP
Application

Namespaces

Composer
Vicchi

Interfaces, Classes, Traits and Enums

ComposerAutoloaderInit4218fb8d9f32b0122bda013c584ba03f

Table of Contents

_ISOCODE_COEFF_MAX_DISTANT  = 5
_ISOCODE_GEOMETRIE_MAX_INSERT  = 50
_ISOCODE_GEONAMES_INFORMATIONS_PAYS  = 'services/nomenclature/iso/iso3166countries-geonames-info.tab'
Chemin du fichier Geonames contenant des informations géographiques sur les pays.
_ISOCODE_INSEECOMMUNE_LATLON  = 'services/infrasubdivision/inseecommune-latlon.csv'
Chemin du fichier contenant les coordonnées géographiques des communes fraançaises.
_ISOCODE_IOTA_ISO4217_SYMBOL  = 'http://www.iotafinance.com/Codes-ISO-Devises.html'
URL de base pour charger la page du tableau des devises ISO-4217 sur le site de IOTA Finance qui permet de compléter les informations de base de l'ISO-4217.
_ISOCODE_LOC_ISO639_5_HIERARCHY  = 'https://www.loc.gov/standards/iso639-5/hier.php'
URL de base pour charger la page du tableau de la hiérarchie ISO-639-5 sur le site de la Library of Congress. Complément à la table iso639families.
_ISOCODE_M49_REGION_PAYS  = 'services/nomenclature/m49/m49regions_countries.csv'
Chemin du fichier des régions-pays M49 contenant la région de rattachement des pays.
_ISOCODE_PATTERN_UNTERM_TRADUCTIONS  = 'services/nomenclature/iso/iso3166countries-trad-unterm-*.csv'
Chemin du fichier des régions-pays M49 contenant la région de rattachement des pays.
_ISOCODE_SIL_ISO639_3_ENDPOINT  = 'http://www-01.sil.org/iso639-3/documentation.asp?id='
URL de base pour charger la page de documentation d'un code de langue alpha-3 sur le site sil.org. Complément à la table iso639families.
isocode_declarer_tables_principales()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin.
isocode_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
isocode_erreur_codes_spip()  : array<string|int, mixed>
isocode_verifier_codes_spip()  : array<string|int, mixed>
isocode_verifier_iso639_5()  : array<string|int, mixed>
zones_collectionner()  : array<string|int, mixed>
Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.
pays_collectionner()  : array<string|int, mixed>
Récupère la liste des pays de la table spip_iso3166countries éventuellement filtrés par les critères additionnels positionnés dans la requête.
pays_verifier_filtre_zone()  : bool
Détermine si la valeur du critère de région d'appartenance du pays est valide.
pays_verifier_filtre_continent()  : bool
Détermine si la valeur du continent d'appartenance du pays est valide.
subdivisions_collectionner()  : array<string|int, mixed>
Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
subdivisions_conditionner_pays()  : string
Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
infrasubdivisions_collectionner()  : array<string|int, mixed>
Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
infrasubdivisions_conditionner_pays()  : string
Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
contours_collectionner()  : array<string|int, mixed>
Récupère la liste des contours géographiques de la table spip_boundaries.
contours_conditionner_service()  : string
Calcule la condition du filtre service pour lequel il est possible de passer une liste de services séparés par une virgule.
services_collectionner()  : array<string|int, mixed>
Récupère les configuration des services.
isocode_reponse_expliquer_erreur()  : mixed
formulaires_isocode_peupler_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose les actions possibles sur les tables de codes ISO, à savoir, charger ou vider et la liste des tables regroupées par service.
formulaires_isocode_peupler_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`decharger` ou `charger`) et une table.
formulaires_isocode_peupler_traiter()  : array<string|int, mixed>
Exécution du formulaire : les tables choisies sont soit vidées, soit chargées.
isocode_peupler_notifier()  : array<string|int, mixed>
Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des tables de codes ISO.
isocode_charger()  : array<string|int, mixed>
Charge en base de données une liste de tables de codes ISO donnée.
isocode_decharger()  : array<string|int, mixed>
Supprime en base de données, le contenu des tables de codes ISO choisies.
isocode_lister_types_service()  : array<string|int, mixed>
Retourne la liste des services disponibles pour le chargement des tables de codes ISO.
isocode_lister_services()  : array<string|int, mixed>
Retourne la liste des services disponibles pour le chargement des tables de codes ISO.
isocode_trouver_service()  : string|array<string|int, mixed>
Détermine le service associé au chargement de la table de codes ISO choisie.
isocode_lister_tables()  : array<string|int, mixed>
Retourne la liste de toutes les tables gérées par le plugin ou de celles associées à un ou plusieurs services donnés.
isocode_trouver_table()  : string|array<string|int, mixed>
Détermine le service associé au chargement de la table de codes ISO choisie.
isocode_crediter()  : bool
Renvoie la configuration d'un service.
isocode_lire_consignation()  : bool
Indique si une table est déjà chargée ou pas en base de données.
lire_source()  : array<string|int, mixed>
Constitue, à partir, d'un fichier CSV ou XML ou d'une page HTML au format texte, un tableau des éléments prêt à être inséré dans une table de la base de données.
obtenir_cle_primaire()  : array<string|int, mixed>
initialiser_enregistrement()  : array<string|int, mixed>
Initialise un élément d'une table donnée avec les valeurs par défaut configurées dans la déclaration de la base ou avec une valeur prédéfinie par type.
inserer_enregistrements()  : bool
extraire_contenu_source()  : array<string|int, mixed>
extraire_element()  : array<string|int, mixed>
completer_element()  : array<string|int, mixed>
sha_identique()  : bool
Compare le sha passé en argument pour la table concernée avec le sha stocké dans la meta pour cette même table.
compiler_champs()  : mixed
consigner_chargement()  : mixed
deconsigner_chargement()  : mixed
decoder_xml_json()  : array<string|int, mixed>|mixed|string
configuration_lire()  : bool
Renvoie la configuration d'un service.
completer_traduction()  : string
Complète un texte sous forme de balise multi avec une liste de traductions.
completer_profondeur()  : mixed
isocode_upgrade()  : void
Fonction d'installation et de mise à jour du plugin.
isocode_vider_tables()  : void
Fonction de désinstallation du plugin.
isocode_liste_ezcollection()  : array<string|int, mixed>
Déclare les collections accessibles via l'API ezREST.
isocode_informer_consignation()  : array<string|int, mixed>
Informe sur la liste des tables déjà chagées en base de données.
continents_completer_element()  : mixed
countries_completer_element()  : mixed
frregion_completer_element()  : mixed
frdepartment_completer_element()  : mixed
deland_completer_element()  : mixed
chcanton_completer_element()  : mixed
beregion_completer_element()  : mixed
beprovince_completer_element()  : mixed
usstate_completer_element()  : mixed
nlprovince_completer_element()  : mixed
ptdistrict_completer_element()  : mixed
inseearrond_completer_element()  : mixed
inseeepci_completer_element()  : mixed
inseecommune_completer_element()  : mixed
inseecommune_completer_table()  : mixed
iso639families_completer_enregistrement()  : mixed
iso639families_completer_table()  : mixed
iso3166countries_completer_table()  : mixed
iso3166subdivisions_completer_enregistrement()  : mixed
iso3166subdivisions_fusionner_enregistrement()  : mixed
iso3166subdivisions_completer_table()  : mixed
iso4217currencies_completer_table()  : mixed

Constants

_ISOCODE_GEONAMES_INFORMATIONS_PAYS

Chemin du fichier Geonames contenant des informations géographiques sur les pays.

public mixed _ISOCODE_GEONAMES_INFORMATIONS_PAYS = 'services/nomenclature/iso/iso3166countries-geonames-info.tab'

Complément à la table iso639countries.

_ISOCODE_INSEECOMMUNE_LATLON

Chemin du fichier contenant les coordonnées géographiques des communes fraançaises.

public mixed _ISOCODE_INSEECOMMUNE_LATLON = 'services/infrasubdivision/inseecommune-latlon.csv'

Complément à la table infrasubdivisions.

_ISOCODE_IOTA_ISO4217_SYMBOL

URL de base pour charger la page du tableau des devises ISO-4217 sur le site de IOTA Finance qui permet de compléter les informations de base de l'ISO-4217.

public mixed _ISOCODE_IOTA_ISO4217_SYMBOL = 'http://www.iotafinance.com/Codes-ISO-Devises.html'

Complément à la table iso639currencies.

_ISOCODE_LOC_ISO639_5_HIERARCHY

URL de base pour charger la page du tableau de la hiérarchie ISO-639-5 sur le site de la Library of Congress. Complément à la table iso639families.

public mixed _ISOCODE_LOC_ISO639_5_HIERARCHY = 'https://www.loc.gov/standards/iso639-5/hier.php'

_ISOCODE_M49_REGION_PAYS

Chemin du fichier des régions-pays M49 contenant la région de rattachement des pays.

public mixed _ISOCODE_M49_REGION_PAYS = 'services/nomenclature/m49/m49regions_countries.csv'

Complément à la table iso639countries.

_ISOCODE_PATTERN_UNTERM_TRADUCTIONS

Chemin du fichier des régions-pays M49 contenant la région de rattachement des pays.

public mixed _ISOCODE_PATTERN_UNTERM_TRADUCTIONS = 'services/nomenclature/iso/iso3166countries-trad-unterm-*.csv'

Complément à la table iso639countries.

_ISOCODE_SIL_ISO639_3_ENDPOINT

URL de base pour charger la page de documentation d'un code de langue alpha-3 sur le site sil.org. Complément à la table iso639families.

public mixed _ISOCODE_SIL_ISO639_3_ENDPOINT = 'http://www-01.sil.org/iso639-3/documentation.asp?id='

Functions

isocode_declarer_tables_principales()

Déclaration des nouvelles tables de la base de données propres au plugin.

isocode_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>

Le plugin déclare des tables ISO-639 issues de 2 bases de données (SIL et Library of Congress uniquement pour les familles de langues) :

  • spip_iso639codes, qui contient les codes ISO-639-3, 2 et 1,
  • spip_iso639names, qui contient les noms de langue,
  • spip_iso639macros, qui contient le mapping des macrolangues,
  • spip_iso639retirements, qui contient les langues retirées de la liste officielle,
  • spip_iso639families, qui contient les familles et groupes de langues ISO-639-5,

Le plugin déclare aussi une table spip_iso15924scripts qui contient les codets d'écriture à 4 lettres et leur définition en français et en anglais et une table spip_iana5646subtags qui contient les codes des sous-étiquettes des étiquettes de langue construites selon la RFC 5646.

Le plugin déclare aussi un ensemble de tables liées aux différents découpages géographiques, à savoir:

  • spip_geoipcontinents qui contient les indicatifs GeoIP des continents.
  • spip_m49regions qui contient les indicatifs M49 des zones géographiques englobant les pays.
  • spip_iso3166countries qui contient les indicatifs ISO-3166-1 des pays.
  • spip_iso3166subdivisions qui contient les indicatifs ISO-3166-2 des subdivisions des pays.
  • spip_infrasubdivisions qui contient les indicatifs nationaux des infra-subdivisions des pays.

Le plugin déclare aussi une table spip_iso3166alternates qui contient des codes nationaux ou supranationaux alternatifs aux codes IS0 3166 (NUTS, INSEE...), et la table des devises ISO-4217 spip_iso4217currencies

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

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_principales

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

isocode_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

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

Le plugin se contente de déclarer les alias des tables qu'il ajoute.

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

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles informations

isocode_erreur_codes_spip()

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

isocode_verifier_codes_spip()

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

isocode_verifier_iso639_5()

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

zones_collectionner()

Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.

zones_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.

pays_collectionner()

Récupère la liste des pays de la table spip_iso3166countries éventuellement filtrés par les critères additionnels positionnés dans la requête.

pays_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.

pays_verifier_filtre_zone()

Détermine si la valeur du critère de région d'appartenance du pays est valide.

pays_verifier_filtre_zone(string $zone, array<string|int, mixed> &$erreur) : bool

La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec un code à 3 chiffres.

Parameters
$zone : string

La valeur du critère région, soit son code ISO 3166-1 numérique (3 chiffres).

$erreur : array<string|int, mixed>

Bloc d'erreur préparé au cas où la vérification retourne une erreur. Dans ce cas, le bloc et complété et renvoyé.

Return values
bool

true si la valeur est valide, false sinon.

pays_verifier_filtre_continent()

Détermine si la valeur du continent d'appartenance du pays est valide.

pays_verifier_filtre_continent(string $continent, array<string|int, mixed> &$erreur) : bool

La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec une code à deux lettres majuscules.

Parameters
$continent : string

La valeur du critère région, soit son code ISO 3166-1 numérique (3 chiffres).

$erreur : array<string|int, mixed>

Bloc d'erreur préparé au cas où la vérification retourne une erreur. Dans ce cas, le bloc et complété et renvoyé.

Return values
bool

true si la valeur est valide, false sinon.

subdivisions_collectionner()

Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.

subdivisions_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.

subdivisions_conditionner_pays()

Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.

subdivisions_conditionner_pays(string $valeur) : string
Parameters
$valeur : string

Valeur du critère country.

Return values
string

Toujours la chaine vide.

infrasubdivisions_collectionner()

Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.

infrasubdivisions_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$conditions : array<string|int, mixed>

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.

infrasubdivisions_conditionner_pays()

Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.

infrasubdivisions_conditionner_pays(string $valeur) : string
Parameters
$valeur : string

Valeur du critère exclure.

Return values
string

Toujours la chaine vide.

contours_collectionner()

Récupère la liste des contours géographiques de la table spip_boundaries.

contours_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>

Il est obligatoire de choisir à minima un type de territoire de façon à limiter le transfert d'informations via l'API REST. Un critère facultatif permet de filtrer sur le service ce qui est recommandé.

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

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.

contours_conditionner_service()

Calcule la condition du filtre service pour lequel il est possible de passer une liste de services séparés par une virgule.

contours_conditionner_service(string $valeur) : string
Parameters
$valeur : string

Valeur du critère service.

Return values
string

Toujours la chaine vide.

services_collectionner()

Récupère les configuration des services.

services_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>

Il est possible de filtrer la liste avec le critère facultatif type de service (nomenclature, geometrie).

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

Conditions à appliquer au select

$filtres : array<string|int, mixed>

Tableau des critères de filtrage additionnels à appliquer au select.

$configuration : array<string|int, mixed>

Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.

Return values
array<string|int, mixed>

Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.

isocode_reponse_expliquer_erreur()

isocode_reponse_expliquer_erreur(mixed $erreur) : mixed
Parameters
$erreur : mixed
Return values
mixed

formulaires_isocode_peupler_charger()

Chargement des données : le formulaire propose les actions possibles sur les tables de codes ISO, à savoir, charger ou vider et la liste des tables regroupées par service.

formulaires_isocode_peupler_charger(string $type) : array<string|int, mixed>

L'action vider s'appelle décharger car il existe dékà une fonction d'administration de vidage des tables.

Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

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_tables : (affichage) alias et libellés des actions possibles sur une table, charger et decharger
  • _actions_disable : (affichage) liste des actions désactivées (decharger si aucune table n`est chargée)
  • _action_defaut : (affichage) action sélectionnée par défaut, charger
  • _tables : (affichage) noms des tables sans le préfixe spip_

formulaires_isocode_peupler_verifier()

Vérification des saisies : il est indispensable de choisir une action (`decharger` ou `charger`) et une table.

formulaires_isocode_peupler_verifier(mixed $type) : array<string|int, mixed>
Parameters
$type : mixed
Return values
array<string|int, mixed>

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

formulaires_isocode_peupler_traiter()

Exécution du formulaire : les tables choisies sont soit vidées, soit chargées.

formulaires_isocode_peupler_traiter(mixed $type) : array<string|int, mixed>
Parameters
$type : mixed
Tags
uses
isocode_charger_tables()
uses
isocode_decharger_tables()
uses
formater_message()
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.

isocode_peupler_notifier()

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

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

Action venant d'être appliquée à certaines tables. Peut prendre les valeurs charger et decharger.

$statuts : mixed
Return values
array<string|int, mixed>

Tableau des messages à afficher sur le formulaire:

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

isocode_charger()

Charge en base de données une liste de tables de codes ISO donnée.

isocode_charger(string $type, string $service, string $table) : array<string|int, mixed>

Si la liste est vide, la fonction charge toutes les tables disponibles.

Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infrasubdivision ou geometrie.

$service : string
$table : string
Tags
filtre
uses
consigner_chargement()
uses
lire_source()
uses
isocode_decharger_tables()
Return values
array<string|int, mixed>

Tableau associatif résultat de l'action de vidage:

  • index ok : true si le vidage a réussi, false sinon.
  • index elements_ok : liste des tables vidées avec succès ou tableau vide sinon.
  • index elements_nok : liste des tables en erreur ou tableau vide sinon.
  • index elements_sha : liste des tables inchangées (SHA identique) ou tableau vide sinon.

isocode_decharger()

Supprime en base de données, le contenu des tables de codes ISO choisies.

isocode_decharger(string $type, string $service, string $table) : array<string|int, mixed>

Si la liste des tables est vide la fonction considère que toutes les tables doivent être vidées. La meta concernant les informations de chargement de chaque table est aussi effacée.

Parameters
$type : string
$service : string
$table : string

Liste des tables à vider. Si le tableau est vide l'ensemble des tables seront vidées. Les tables doivent être libellées sans le préfixe spip_.

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

Tableau associatif résultat de l'action de vidage:

  • index ok : true si le vidage a réussi, false sinon.
  • index elements_ok : liste des tables vidées avec succès ou tableau vide sinon.
  • index elements_nok : liste des tables en erreur ou tableau vide sinon.

isocode_lister_types_service()

Retourne la liste des services disponibles pour le chargement des tables de codes ISO.

isocode_lister_types_service() : array<string|int, mixed>

La fonction lit les sous-répertoires du répertoire services/ du plugin et vérifie qu'un fichier d'API existe.

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

La liste des services disponibles ou tableau vide aucun service n'est détecté.

isocode_lister_services()

Retourne la liste des services disponibles pour le chargement des tables de codes ISO.

isocode_lister_services(mixed $type) : array<string|int, mixed>

La fonction lit les sous-répertoires du répertoire services/ du plugin et vérifie qu'un fichier d'API existe.

Parameters
$type : mixed
Tags
filtre
Return values
array<string|int, mixed>

La liste des services disponibles ou tableau vide aucun service n'est détecté.

isocode_trouver_service()

Détermine le service associé au chargement de la table de codes ISO choisie.

isocode_trouver_service(mixed $type,  $table) : string|array<string|int, mixed>

Si la table est vide ou invalide, la fonction renvoie une chaîne vide.

Parameters
$type : mixed
$table :

Nom d'une table sans le préfixe spip_.

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

Le ou les services associés à la table fournie suivant le type de service.

  • nomenclature : service unique permettant le chargement de la table ou chaîne vide.
  • geometrie : tableau des services permettant le chargement de la table ou tableau vide.

isocode_lister_tables()

Retourne la liste de toutes les tables gérées par le plugin ou de celles associées à un ou plusieurs services donnés.

isocode_lister_tables(mixed $type[, mixed $avec_groupes = false ]) : array<string|int, mixed>
Parameters
$type : mixed
$avec_groupes : mixed = false
Tags
filtre
uses
isocode_lister_services()
uses
service_est_disponible()
Return values
array<string|int, mixed>

Liste des tables sans le préfixe spip_.

isocode_trouver_table()

Détermine le service associé au chargement de la table de codes ISO choisie.

isocode_trouver_table(mixed $type, mixed $service) : string|array<string|int, mixed>

Si la table est vide ou invalide, la fonction renvoie une chaîne vide.

Parameters
$type : mixed
$service : mixed
Tags
filtre
uses
isocode_lister_services()
Return values
string|array<string|int, mixed>

Le ou les tables associées au service fourni suivant le type de service.

  • nomenclature : tableau des tables pouvant être chargées par le service ou tableau vide.
  • geometrie : table unique pouvant être chargée par le service ou chaine vide.

isocode_crediter()

Renvoie la configuration d'un service.

isocode_crediter(string $type, string $service[, string $table = '' ]) : bool
Parameters
$type : string
$service : string
$table : string = ''

Nom de la table sans le préfixe spip_.

Tags
filtre
Return values
bool

true si la table est chargée, false sinon.

isocode_lire_consignation()

Indique si une table est déjà chargée ou pas en base de données.

isocode_lire_consignation(mixed $type, mixed $service, string $table) : bool

La fonction scrute la table spip_${table} et non la meta propre à la table.

Parameters
$type : mixed
$service : mixed
$table : string

Nom de la table sans le préfixe spip_.

Tags
filtre
Return values
bool

true si la table est chargée, false sinon.

lire_source()

Constitue, à partir, d'un fichier CSV ou XML ou d'une page HTML au format texte, un tableau des éléments prêt à être inséré dans une table de la base de données.

lire_source(mixed $type, string $service, string $table) : array<string|int, mixed>

La fonction utilise le service et le nom de table pour récupérer la configuration permettant l'analyse du fichier et sa traduction en éléments de la table (délimiteur ou regexp, nom des colonnes...). Il est possible, pour chaque élément ou pour l'ensemble d'appliquer une fonction spécifique à la table qui complète l'élément.

Parameters
$type : mixed
$service : string

Nom du service associé à la lecture de la table.

$table : string

Nom de la table concernée par la lecture de la source.

Return values
array<string|int, mixed>

Tableau à deux éléments:

  • index 0 : la liste des éléments à enregistrer dans la table concernée
  • index 1 : le sha256 de la source des éléments de la table
  • index 2 : indicateur de sha identique

obtenir_cle_primaire()

obtenir_cle_primaire( $table) : array<string|int, mixed>
Parameters
$table :
Return values
array<string|int, mixed>

initialiser_enregistrement()

Initialise un élément d'une table donnée avec les valeurs par défaut configurées dans la déclaration de la base ou avec une valeur prédéfinie par type.

initialiser_enregistrement(string $table, array<string|int, mixed> $config_source[, mixed $config_unused = array() ]) : array<string|int, mixed>
Parameters
$table : string

Nom de la table concernée par la lecture sans le préfixe spip_.

$config_source : array<string|int, mixed>

Configuration de la correspondance entre le nom de la donnée dans la source et celui du champ dans la table.

$config_unused : mixed = array()
Return values
array<string|int, mixed>

inserer_enregistrements()

inserer_enregistrements( $type,  $enregistrements,  $table) : bool
Parameters
$type :
$enregistrements :
$table :
Return values
bool

extraire_contenu_source()

extraire_contenu_source(mixed $type,  $service,  $table,  $config) : array<string|int, mixed>
Parameters
$type : mixed
$service :
$table :
$config :

Configuration de la méthode de lecture de la source pour la table concernée.

Return values
array<string|int, mixed>

extraire_element()

extraire_element( $contenu,  $titres,  $config) : array<string|int, mixed>
Parameters
$contenu :
$titres :
$config :
Return values
array<string|int, mixed>

completer_element()

completer_element( $type,  $service,  $table,  $config,  $element) : array<string|int, mixed>
Parameters
$type :
$service :
$table :
$config :

Configuration de la méthode de lecture de la source pour la table concernée.

$element :
Return values
array<string|int, mixed>

sha_identique()

Compare le sha passé en argument pour la table concernée avec le sha stocké dans la meta pour cette même table.

sha_identique(string $sha, string $table) : bool
Parameters
$sha : string

SHA à comparer à celui de la table.

$table : string

Nom de la table sans préfixe spip_ dont il faut comparer le sha stocké dans sa meta de chargement.

Return values
bool

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

compiler_champs()

compiler_champs( $config) : mixed
Parameters
$config :
Return values
mixed

consigner_chargement()

consigner_chargement( $meta,  $type,  $service,  $table) : mixed
Parameters
$meta :
$type :
$service :
$table :
Return values
mixed

deconsigner_chargement()

deconsigner_chargement( $type,  $service,  $table) : mixed
Parameters
$type :
$service :
$table :
Return values
mixed

decoder_xml_json()

decoder_xml_json( $xml_json,  $config) : array<string|int, mixed>|mixed|string
Parameters
$xml_json :
$config :
Tags
throws
Exception
Return values
array<string|int, mixed>|mixed|string

configuration_lire()

Renvoie la configuration d'un service.

configuration_lire(string $type, string $service[, string $table = '' ][, string $variable = '' ][, mixed $defaut = array() ]) : bool
Parameters
$type : string
$service : string
$table : string = ''

Nom de la table sans le préfixe spip_.

$variable : string = ''

Nom de la table sans le préfixe spip_.

$defaut : mixed = array()

Nom de la table sans le préfixe spip_.

Tags
filtre
Return values
bool

true si la table est chargée, false sinon.

completer_traduction()

Complète un texte sous forme de balise multi avec une liste de traductions.

completer_traduction(string $multi_in, array<string|int, mixed> $traductions) : string

Les nouvelles traductions, si elles sont non vides, sont soit ajoutées, soit écrasent la la traduction courante.

Parameters
$multi_in : string
$traductions : array<string|int, mixed>
Return values
string

completer_profondeur()

completer_profondeur(mixed $enregistrements, mixed $config_profondeur) : mixed
Parameters
$enregistrements : mixed
$config_profondeur : mixed
Return values
mixed

isocode_upgrade()

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

isocode_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma du plugin est composé des tables spip_iso639xxxx et d'une configuration.

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 (déclaré dans paquet.xml)

Return values
void

isocode_vider_tables()

Fonction de désinstallation du plugin.

isocode_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

isocode_liste_ezcollection()

Déclare les collections accessibles via l'API ezREST.

isocode_liste_ezcollection(array<string|int, mixed> $collections) : array<string|int, mixed>

Par défaut, le plugin propose une liste de collections.

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

Configuration des collections déjà déclarées.

Tags
pipeline

liste_ezcollection

Return values
array<string|int, mixed>

Collections complétées.

isocode_informer_consignation()

Informe sur la liste des tables déjà chagées en base de données.

isocode_informer_consignation(mixed $type) : array<string|int, mixed>

Les informations de la meta de chaque table sont complétées et renvoyées.

Parameters
$type : mixed
Tags
filtre
Return values
array<string|int, mixed>

Liste des tables de codes ISO sans le préfixe spip_ et leurs informations de chargement.

continents_completer_element()

continents_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

countries_completer_element()

countries_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

frregion_completer_element()

frregion_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

frdepartment_completer_element()

frdepartment_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

deland_completer_element()

deland_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

chcanton_completer_element()

chcanton_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

beregion_completer_element()

beregion_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

beprovince_completer_element()

beprovince_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

usstate_completer_element()

usstate_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

nlprovince_completer_element()

nlprovince_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

ptdistrict_completer_element()

ptdistrict_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

inseearrond_completer_element()

inseearrond_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

inseeepci_completer_element()

inseeepci_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

inseecommune_completer_element()

inseecommune_completer_element(mixed $element, mixed $config) : mixed
Parameters
$element : mixed
$config : mixed
Return values
mixed

inseecommune_completer_table()

inseecommune_completer_table(mixed $enregistrements, mixed $config) : mixed
Parameters
$enregistrements : mixed
$config : mixed
Return values
mixed

iso639families_completer_enregistrement()

iso639families_completer_enregistrement(mixed $enregistrement, mixed $config) : mixed
Parameters
$enregistrement : mixed
$config : mixed
Return values
mixed

iso639families_completer_table()

iso639families_completer_table(mixed $enregistrements, mixed $config) : mixed
Parameters
$enregistrements : mixed
$config : mixed
Return values
mixed

iso3166countries_completer_table()

iso3166countries_completer_table(mixed $enregistrements, mixed $config) : mixed
Parameters
$enregistrements : mixed
$config : mixed
Return values
mixed

iso3166subdivisions_completer_enregistrement()

iso3166subdivisions_completer_enregistrement(mixed $enregistrement, mixed $config) : mixed
Parameters
$enregistrement : mixed
$config : mixed
Return values
mixed

iso3166subdivisions_fusionner_enregistrement()

iso3166subdivisions_fusionner_enregistrement(mixed $enregistrements, mixed $index_enregistrement, mixed $enregistrement, mixed $config) : mixed
Parameters
$enregistrements : mixed
$index_enregistrement : mixed
$enregistrement : mixed
$config : mixed
Return values
mixed

iso3166subdivisions_completer_table()

iso3166subdivisions_completer_table(mixed $enregistrements, mixed $config) : mixed
Parameters
$enregistrements : mixed
$config : mixed
Return values
mixed

iso4217currencies_completer_table()

iso4217currencies_completer_table(mixed $enregistrements, mixed $config) : mixed
Parameters
$enregistrements : mixed
$config : mixed
Return values
mixed

Search results