Browse Source

doc: fix PHPDoc

pull/46/head
b_b 2 months ago
parent
commit
75565e38af
  1. 2
      action/editer_gis.php
  2. 5
      crud/gis.php
  3. 12
      formulaires/editer_gis.php
  4. 6
      formulaires/rechercher_gis.php
  5. 42
      gis_fonctions.php
  6. 22
      gis_pipelines.php
  7. 2
      inc/gis_geocode.php

2
action/editer_gis.php

@ -64,7 +64,7 @@ function gis_inserer($set = null) {
* https://code.spip.net/@articles_set
*
* @param int $id_gis l'identifiant numérique du point
* @param null/array $set un array des valeurs à mettre en base (par défaut false, on récupère les valeurs passées en dans le POST)
* @param null|array $set un array des valeurs à mettre en base (par défaut false, on récupère les valeurs passées en dans le POST)
* @return string
*/
function gis_modifier($id_gis, $set = null) {

5
crud/gis.php

@ -14,7 +14,7 @@ include_spip('action/editer_gis');
* Create :
* Crée un point géolocalisé
*
* @param $dummy
* @param string $dummy
* @param array $set : Le contenu des champs à mettre en base
* @return array : un array avec (bool) success, (string) message et (array) result indiquant l'id créé
*/
@ -32,7 +32,7 @@ function crud_gis_create_dist($dummy, $set = null) {
* Update :
* Met à jour un point géolocalisé
*
* @param $dummy
* @param int $id
* @param array $set : Le contenu des champs à mettre en base
* @return array : un array avec (bool) success, (string) message et (array) result indiquant l'id créé
*/
@ -52,7 +52,6 @@ function crud_gis_update_dist($id, $set = null) {
* Delete :
* Supprime un point géolocalisé
*
* @param $dummy
* @param int $id : L'identifiant numérique du point à supprimer
* @return array : un array avec (bool) success, (string) message et (array) result indiquant l'id supprimé
*/

12
formulaires/editer_gis.php

@ -16,10 +16,10 @@ include_spip('inc/editer');
*
* @param int|string $id_gis Identifiant numérique du point ou 'new' pour un nouveau
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $ajaxload initialiser la carte à chaque onAjaxLoad()
* @param array $options TODO à documenter, voir avec l'auteur de https://zone.spip.org/trac/spip-zone/changeset/53906
* @param array|string $options TODO à documenter, voir avec l'auteur de https://zone.spip.org/trac/spip-zone/changeset/53906
*/
function formulaires_editer_gis_charger_dist($id_gis = 'new', $objet = '', $id_objet = '', $retour = '', $ajaxload = 'oui', $options = '') {
$valeurs = formulaires_editer_objet_charger('gis', $id_gis, '', '', $retour, '');
@ -69,10 +69,10 @@ function formulaires_editer_gis_charger_dist($id_gis = 'new', $objet = '', $id_o
*
* @param int|string $id_gis Identifiant numérique du point ou 'new' pour un nouveau
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $ajaxload initialiser la carte à chaque onAjaxLoad()
* @param array $options ???
* @param array|string $options TODO à documenter, voir avec l'auteur de https://zone.spip.org/trac/spip-zone/changeset/53906
*/
function formulaires_editer_gis_verifier_dist($id_gis = 'new', $objet = '', $id_objet = '', $retour = '', $ajaxload = 'oui', $options = '') {
$erreurs = formulaires_editer_objet_verifier('gis', $id_gis, ['titre', 'lat', 'lon', 'zoom']);
@ -84,10 +84,10 @@ function formulaires_editer_gis_verifier_dist($id_gis = 'new', $objet = '', $id_
*
* @param int|string $id_gis Identifiant numérique du point ou 'new' pour un nouveau
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $ajaxload initialiser la carte à chaque onAjaxLoad()
* @param array $options ???
* @param array|string $options TODO à documenter, voir avec l'auteur de https://zone.spip.org/trac/spip-zone/changeset/53906
*/
function formulaires_editer_gis_traiter_dist($id_gis = 'new', $objet = '', $id_objet = '', $retour = '', $ajaxload = 'oui', $options = '') {
return formulaires_editer_objet_traiter('gis', $id_gis, '', '', $retour, '');

6
formulaires/rechercher_gis.php

@ -15,7 +15,7 @@ include_spip('inc/editer');
* Chargement des valeurs par défaut du formulaire
*
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $recherche
*/
@ -30,7 +30,7 @@ function formulaires_rechercher_gis_charger_dist($objet = '', $id_objet = '', $r
* Vérification des valeurs du formulaire
*
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $recherche
*/
@ -43,7 +43,7 @@ function formulaires_rechercher_gis_verifier_dist($objet = '', $id_objet = '', $
* Traitement des valeurs du formulaire
*
* @param string $objet Le type d'objet SPIP auquel il est attaché
* @param int $id_objet L'id_objet de l'objet auquel il est attaché
* @param int|string $id_objet L'id_objet de l'objet auquel il est attaché
* @param string $retour L'url de retour
* @param string $recherche
*/

42
gis_fonctions.php

@ -10,7 +10,7 @@ include_spip('inc/json');
/**
* Filtre dec_to_dms, http://www.statemaster.com/encyclopedia/Geographic-coordinate-conversion
*
* @param decimal $coord
* @param float $coord
* @return string
*/
function dec_to_dms($coord) {
@ -28,7 +28,7 @@ function dec_to_dms($coord) {
* @param int $deg
* @param int $min
* @param int $sec
* @return decimal
* @return float
*/
function dms_to_dec($ref, $deg, $min, $sec) {
@ -126,9 +126,10 @@ function distance_en_metres($distance, $precision = 2, $format_entree = 'km') {
* {distancefrom #ARRAY{lat,#LAT,lon,#LON},<,30}
* {distancefrom #ARRAY{lat,#ENV{lat},lon,#ENV{lon}},<=,#ENV{distance}}
*
* @param unknown $idb
* @param unknown &$boucles
* @param unknown $crit
* @param string $idb Identifiant de la boucle
* @param object $boucles AST du squelette
* @param object $crit Paramètres du critère dans cette boucle
* @return void
*/
function critere_distancefrom_dist($idb, &$boucles, $crit) {
$boucle = &$boucles[$idb];
@ -167,9 +168,10 @@ function critere_distancefrom_dist($idb, &$boucles, $crit) {
* - `{!gis}` Retourne les objets sans points
* - `{gis distance<XX}`, sur une boucle `GIS`, filtre une liste de points par rapport à la distance du point de l'env
*
* @param string $idb
* @param array $boucles
* @param Critere $crit
* @param string $idb Identifiant de la boucle
* @param object $boucles AST du squelette
* @param object $crit Paramètres du critère dans cette boucle
* @return void
*/
function critere_gis_dist($idb, &$boucles, $crit) {
$boucle = &$boucles[$idb];
@ -274,7 +276,7 @@ function critere_gis_tout_dist($idb, &$boucles, $crit) {
* Retourne la distance calculée par GIS en présence des critères adéquats,
* sinon la valeur du champ.
*
* @param unknown_type $p
* @param object $p
*/
function balise_distance_dist($p) {
$p = rindex_pile($p, 'distance', 'gis');
@ -288,7 +290,7 @@ function balise_distance_dist($p) {
* Balise #TITRE_GIS : retourne le titre du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_titre_gis_dist($p) {
return rindex_pile($p, 'titre_gis', 'gis');
@ -298,7 +300,7 @@ function balise_titre_gis_dist($p) {
* Balise #DESCRIPTIF_GIS : retourne le descriptif du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_descriptif_gis_dist($p) {
return rindex_pile($p, 'descriptif_gis', 'gis');
@ -308,7 +310,7 @@ function balise_descriptif_gis_dist($p) {
* Balise #ADRESSE_GIS : retourne l'adresse du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_adresse_gis_dist($p) {
return rindex_pile($p, 'adresse_gis', 'gis');
@ -318,7 +320,7 @@ function balise_adresse_gis_dist($p) {
* Balise #PAYS_GIS : retourne le pays du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_pays_gis_dist($p) {
return rindex_pile($p, 'pays_gis', 'gis');
@ -328,7 +330,7 @@ function balise_pays_gis_dist($p) {
* Balise #CODE_PAYS_GIS : retourne le code pays du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_code_pays_gis_dist($p) {
return rindex_pile($p, 'code_pays_gis', 'gis');
@ -338,7 +340,7 @@ function balise_code_pays_gis_dist($p) {
* Balise #VILLE_GIS : retourne la ville du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_ville_gis_dist($p) {
return rindex_pile($p, 'ville_gis', 'gis');
@ -348,7 +350,7 @@ function balise_ville_gis_dist($p) {
* Balise #REGION_GIS : retourne la région du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_region_gis_dist($p) {
return rindex_pile($p, 'region_gis', 'gis');
@ -358,7 +360,7 @@ function balise_region_gis_dist($p) {
* Balise #DEPARTEMENT_GIS : censé retourner le département du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_departement_gis_dist($p) {
return rindex_pile($p, 'departement_gis', 'gis');
@ -368,7 +370,7 @@ function balise_departement_gis_dist($p) {
* Balise #CODE_POSTAL_GIS : retourne le code postal du point
* Necessite le critere {gis} sur la boucle
*
* @param unknown_type $p
* @param object $p
*/
function balise_code_postal_gis_dist($p) {
return rindex_pile($p, 'code_postal_gis', 'gis');
@ -392,7 +394,7 @@ function gis_layer_defaut() {
/**
* Recuperer les cles primaires du env pour l'appel a l'url json des points
* @param $env
* @param array|string $env
* @return array
*/
function gis_modele_url_json_env($env) {
@ -531,7 +533,7 @@ if (!defined('_TAILLE_MAX_GIS_STATIC')) {
* Largeur de l'image
* @param int $height
* Hauteur de l'image
* @param string $maptype
* @param string|boolean $maptype
* Le nom de la couche à utiliser en fond de carte
* @param int $zoom
* Le zoom de la carte

22
gis_pipelines.php

@ -7,8 +7,8 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Insertion des css du plugin dans les pages publiques
*
* @param $flux
* @return mixed
* @param string $flux
* @return string
*/
function gis_insert_head_css($flux) {
$flux .= "\n" . '<link rel="stylesheet" href="' . direction_css(sinon(find_in_path('css/leaflet.css'), find_in_path('lib/leaflet/dist/leaflet.css'))) . '" />';
@ -21,8 +21,8 @@ function gis_insert_head_css($flux) {
/**
* Insertion des scripts du plugin dans les pages publiques
*
* @param $flux
* @return mixed
* @param string $flux
* @return string
*/
function gis_insert_head($flux) {
@ -49,8 +49,8 @@ function gis_insert_head($flux) {
/**
* Insertion des scripts et css du plugin dans les pages de l'espace privé
*
* @param $flux
* @return mixed
* @param string $flux
* @return string
*/
function gis_header_prive($flux) {
$flux .= gis_insert_head_css('');
@ -61,8 +61,8 @@ function gis_header_prive($flux) {
/**
* Insertion du bloc GIS dans les pages des objets de l'espace privé
*
* @param $flux
* @return mixed
* @param array $flux
* @return array
*/
function gis_afficher_contenu_objet($flux) {
if (
@ -89,8 +89,8 @@ function gis_afficher_contenu_objet($flux) {
* Si la geolocalisation des documents est activée dans la config,
* création/suppression d'un point à partir des métadonnées du document ajouté (jpg, kml et kmz)
*
* @param $flux
* @return mixed
* @param array $flux
* @return array
*/
function gis_post_edition($flux) {
if (
@ -379,7 +379,7 @@ function gis_formulaire_traiter($flux) {
/**
* Definir le libelle pour les logos GIS dans l'espace prive
* @param array $logo_libelles
* @return mixed
* @return array
*/
function gis_libeller_logo($logo_libelles) {
$logo_libelles['id_gis'] = _T('gis:libelle_logo_gis');

2
inc/gis_geocode.php

@ -11,7 +11,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* mode de geocoding : search ou reverse
* @param array $arguments
* liste des arguments de la requête : format, q, limit, addressdetails, accept-language, lat, lon
* @return array/false données renvoyées par le geocoder, false si échec
* @return string/false données renvoyées par le geocoder, false si échec
*/
function gis_geocode_request($mode, $arguments = []) {

Loading…
Cancel
Save