spip-contrib-extensions
/
territoires
529
3
Fork 0
Code Issues 1 Pull Requests Releases Wiki Activity

PHPDoc

Browse Source
v0_spip32
Eric Lupinacci 3 years ago
parent b3dfd15f4f
commit 62e90d98da
7 changed files with 57 additions and 50 deletions
Show Stats Download Patch File Download Diff File

22
base/territoires.php
Unescape Escape View File

@ -19,11 +19,9 @@ if (!defined('_ECRIRE_INC_VERSION')) {
*
* @pipeline declarer_tables_interfaces
*
* @param array $interfaces
* Déclarations d'interface pour le compilateur
* @param array $interfaces Déclarations d'interface pour le compilateur
*
* @return array
* Déclarations d'interface pour le compilateur
* @return array Déclarations d'interface pour le compilateur
*/
function territoires_declarer_tables_interfaces($interfaces) {
@ -39,14 +37,13 @@ function territoires_declarer_tables_interfaces($interfaces) {
/**
* Déclaration des objets éditoriaux.
* Le plugin Territoires déclare 1 nouvelle table objet, `spip_territoires`.
*
* @pipeline declarer_tables_objets_sql
*
* @param array $tables
* Description des tables
* @param array $tables Description des tables
*
* @return array
* Description complétée des tables
* @return array Description complétée des tables
*/
function territoires_declarer_tables_objets_sql($tables) {
$tables['spip_territoires'] = array(
@ -98,14 +95,15 @@ function territoires_declarer_tables_objets_sql($tables) {
/**
* Déclaration des tables secondaires (liaisons).
* Le plugin Territoires déclare 2 nouvelle tables auxilliaire:
* - celle des liens, `spip_territoires_liens`
* - celle des caractéristiques complémentaires, `spip_territoires_extras`
*
* @pipeline declarer_tables_auxiliaires
*
* @param array $tables
* Description des tables
* @param array $tables Description des tables
*
* @return array
* Description complétée des tables
* @return array Description complétée des tables
*/
function territoires_declarer_tables_auxiliaires($tables) {

2
formulaires/peupler_territoires.php
Unescape Escape View File

@ -2,7 +2,7 @@
/**
* Gestion du formulaire de chargement ou de vidage des territoires.
*
* @package SPIP\TERRITOIRES\OBJET
* @package SPIP\TERRITOIRES\UI
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;

12
inc/territoire.php
Unescape Escape View File

@ -1,8 +1,8 @@
<?php
/**
* Gestion du formulaire de chargement ou de vidage des territoires.
* API de gestion des territoires.
*
* @package SPIP\TERRITOIRES\API
* @package SPIP\TERRITOIRES\API
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
@ -332,8 +332,8 @@ function territoire_depeupler($type, $pays = '') {
}
/**
* Renvoie la liste des pays dont les territoires ont été chargées.
* La fonction lit la meta de chargement et non la table spip_territoires.
* Teste si un type de territoire est chargé en base.
* La fonction lit la meta de chargement et non la table `spip_territoires`.
*
* @api
*
@ -363,8 +363,8 @@ function territoire_est_peuple($type, $pays = '') {
}
/**
* Renvoie la liste des pays dont les territoires ont été chargées.
* La fonction lit la meta de chargement et non la table spip_territoires.
* Teste si les informations complémentaires d’un type de territoire sont chargées en base.
* La fonction lit la meta de chargement et non la table `spip_territoires`.
*
* @api
*

8
inc/territoires_services.php
Unescape Escape View File

@ -1,8 +1,8 @@
<?php
/**
* Gestion du formulaire de chargement ou de vidage des territoires.
* API des services de territoires utilisables par d'autres plugins.
*
* @package SPIP\TERRITOIRES\API
* @package SPIP\TERRITOIRES\API
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
@ -16,7 +16,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* - les pays
* - les subdivisions d'un pays.
*
* @internal
* @api
*
* @param string $type Type de territoires. Prends les valeurs `zone`, `country` ou `subdivision`.
* @param string $pays Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions.
@ -69,7 +69,7 @@ function sha_est_identique($sha, $meta, $consigne) {
/**
* Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.
*
* @internal
* @api
*
* @param string $type_lien Type de liens à restaurer : `liens` ou `logos`.
* @param array $sauvegardes Tableau des sauvegardes dans lequel puiser les liens existants

24
inc/territoires_utils.php
Unescape Escape View File

@ -1,8 +1,8 @@
<?php
/**
* Gestion du formulaire de chargement ou de vidage des territoires.
* Fonctions utilitaires du plugin Territoires appelées par les API.
*
* @package SPIP\TERRITOIRES\API
* @package SPIP\TERRITOIRES\OUTILS
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
@ -19,6 +19,8 @@ if (!defined('_TERRITOIRE_URL_BASE_ISOCODE')) {
* les subdivisions.
* Cette configuration est stockée dans la meta `territoires` à l’installation et n'est pas modifiable.
*
* @internal
*
* @return array
*/
function territoires_configurer() {
@ -93,11 +95,11 @@ function territoires_configurer() {
* Acquiert les données de territoires disponibles dans Nomenclatures.
* La fonction utilise l'API fonctionnelle de Nomenclatures mais pourra ensuite utiliser directement API REST.
*
* @api
* @internal
*
* @param string $type Type de territoires à acquérie. Prends les valeurs `zone`, `country` ou `subdivision`.
* @param string $pays Code ISO 3166-1 alpha2 du pays nécessaire si le type est `subdivision`.
* @param array $options Permet de demander l'exclusion (`exclure`) de certains index si ceux-ci sont inutilisés
* @param array $options Permet de demander l'exclusion (`exclure`) de certains index si ceux-ci sont inutilisés
* ou de ne retourner qu'un seul index (`index`).
*
* @return array
@ -151,7 +153,7 @@ function territoires_acquerir($type, $pays = '', $options = array()) {
* d'une modification manuelle (descriptif ou logo) et la liste associations vers ses mêmes territoires.
* Les extras ne sont pas sauvegardés car il ne sont ni modifiables ni indexés par un id mais par un code invariant.
*
* @api
* @internal
*
* @param string $type Type de territoires à préserver. Prends les valeurs `zone`, `country` ou `subdivision`.
* @param string $pays Code ISO 3166-1 alpha2 du pays nécessaire si le type est `subdivision`.
@ -308,10 +310,12 @@ function traduction_fusionner($multi_prioritaire, $multi_non_prioritaire) {
}
/**
* @param $territoire
* @param $type
* @param array $territoire
* @param string $type
* @param string $pays
*
* @internal
*
* @return array
*/
function enregistrement_initialiser($territoire, $type, $pays = '') {
@ -353,6 +357,10 @@ function enregistrement_initialiser($territoire, $type, $pays = '') {
}
/**
* Compile...
*
* @internal
*
* @param string $mode
* @param array $types_extras
* @param array $source
@ -421,7 +429,7 @@ function extra_compiler($mode, $types_extras, $source, $configuration, $type, $p
* Identifie la variable de configuration à partir du type de territoire et éventuellement du pays pour les
* subdivisions.
*
* @api
* @internal
*
* @param string $type Type de territoires à peupler. Prends les valeurs `zone`, `country` ou `subdivision`.
* @param string $pays Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions.

11
territoires_administrations.php
Unescape Escape View File

@ -17,10 +17,9 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Fonction d'installation et de mise à jour du plugin Territoires.
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @param string $version_cible
* Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
* @param string $nom_meta_base_version Nom de la meta informant de la version du schéma de données du plugin
* installé dans SPIP
* @param string $version_cible Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
* @return void
**/
function territoires_upgrade($nom_meta_base_version, $version_cible) {
@ -53,8 +52,8 @@ function territoires_upgrade($nom_meta_base_version, $version_cible) {
/**
* Fonction de désinstallation du plugin Territoires.
*
* @param string $nom_meta_base_version
* Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
* @param string $nom_meta_base_version Nom de la meta informant de la version du schéma de données du plugin
* installé dans SPIP
* @return void
**/
function territoires_vider_tables($nom_meta_base_version) {

28
territoires_pipelines.php
Unescape Escape View File

@ -14,12 +14,13 @@ if (!defined('_ECRIRE_INC_VERSION')) {
}
/**
* Ajout de contenu sur certaines pages,
* notamment des formulaires de liaisons entre objets
* Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets.
* Territoires ajoute les éventuels caractéristiques complémentaires et le formulaire d'association.
*
* @pipeline affiche_milieu
* @param array $flux Données du pipeline
* @return array Données du pipeline
*
* @return array Données du pipeline
*/
function territoires_affiche_milieu($flux) {
@ -82,12 +83,14 @@ function territoires_affiche_milieu($flux) {
}
/**
* Ajout de contenu dans la colonne « gauche » des pages de l’espace privé,
* notamment « la fiche objet »
* Ajout de contenu dans la colonne « gauche » des pages de l’espace privé, notamment « la fiche objet »
* Territoires ajoute le bloc des codes alternatifs.
*
* @pipeline affiche_gauche
*
* @param array $flux Données du pipeline
* @return array Données du pipeline
*
* @return array Données du pipeline
*/
function territoires_affiche_gauche($flux) {
@ -133,7 +136,7 @@ function territoires_affiche_gauche($flux) {
}
/**
* Enlever l'id_territoire de la liste des critères conditionnels pour la table spip_territoires
* 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.
*
* @param array $flux
@ -149,17 +152,15 @@ function territoires_exclure_id_conditionnel($flux) {
}
/**
* Surcharge l'action `modifier` d'un territoire
* 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.
*
* @pipeline pre_edition
*
* @param array $flux
* Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).
* @param array $flux Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).
*
* @return array
* Données du pipeline modifiées pour refléter le traitement.
* @return array Données du pipeline modifiées pour refléter le traitement.
*
**/
function territoires_pre_edition($flux) {
@ -188,7 +189,8 @@ function territoires_pre_edition($flux) {
*
* @pipeline optimiser_base_disparus
* @param array $flux Données du pipeline
* @return array Données du pipeline
*
* @return array Données du pipeline
*/
function territoires_optimiser_base_disparus($flux) {

Write Preview
Loading…
Cancel
Save