PHPDoc, Changelog

Changelog.md

@@ -1,8 +1,12 @@
 # Plugin abonnements : notes de versions
 
+## v4.0.x
+
+* Compatibilité SPIP 4.x, icones SVG
+
 ## v3.5.x
 
 Ajout de squelettes de résumés génériques pour les abonnements et les offres :
 
 * inclure/resume/abonnement.html + inc-abonnement_footer.html
-* inclure/resume/abonnements_offre.html + inc-abonnements_offre_footer.html
+* inclure/resume/abonnements_offre.html + inc-abonnements_offre_footer.html

abonnements_fonctions.php

@@ -25,7 +25,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * @param Integer|String $duree
  * @param String $periode
  *     heure | jour | mois | an
- * @return void
+ * @return string
  */
 function filtre_abonnements_afficher_duree_dist($duree, $periode) {
 

abonnements_pipelines.php

@@ -13,8 +13,8 @@ if (!defined('_ECRIRE_INC_VERSION')) {
 /**
  * Optimiser la base de donnees des abonnements
  *
- * @param int $n
- * @return int
+ * @param array $flux
+ * @return array
  */
 function abonnements_optimiser_base_disparus($flux) {
 
@@ -38,10 +38,12 @@ function abonnements_optimiser_base_disparus($flux) {
 	return $flux;
 }
 
-/*
+/**
  * Des modifs supplémentaires après édition
+ * @param array $flux
+ * @return array
+ * @throws JsonException
  */
-
 function abonnements_post_edition($flux) {
 	if (empty($flux['args']['table'])) {
 		return $flux;
@@ -191,7 +193,7 @@ function abonnements_post_edition($flux) {
 	return $flux;
 }
 
-/*
+/**
  * Ajout de tâches nécessaires aux abonnements
  *
  * - Une tâche pour vérifier toutes les heures si on a pas trop dépassé des échéances
@@ -202,7 +204,6 @@ function abonnements_post_edition($flux) {
  * @param array $taches Liste des génies et leur périodicité
  * @return array Liste des tâches possiblement modifiées
  */
-
 function abonnements_taches_generales_cron($taches) {
 	$taches['abonnements_verifier_echeances'] = 60 * 60; // toutes les heures
 	$taches['abonnements_verifier_desactivation'] = 60 * 60; // toutes les heures
@@ -235,8 +236,10 @@ function abonnements_affiche_gauche($flux) {
 	return $flux;
 }
 
-/*
+/**
  * Ajouter la boite des abonnements sur la fiche auteur
+ * @param array $flux
+ * @return array
  */
 function abonnements_affiche_milieu($flux) {
 	$e = trouver_objet_exec($flux['args']['exec']);
@@ -259,8 +262,10 @@ function abonnements_affiche_milieu($flux) {
 	return $flux;
 }
 
-/*
+/**
  * Ajouter les offres sur les objets configurés
+ * @param array $flux
+ * @return array
  */
 function abonnements_affiche_enfants($flux) {
 	$e = trouver_objet_exec($flux['args']['exec']);
@@ -342,15 +347,20 @@ function abonnements_affiche_hierarchie($flux) {
 	return $flux;
 }
 
-/*
- *  Ajouter une feuille de style privée
+/**
+ * Ajouter une feuille de style privée
+ * @param string $flux
+ * @return string
  */
-
 function abonnements_header_prive($flux) {
 	$flux = abonnements_insert_head($flux);
 	return $flux;
 }
 
+/**
+ * @param string $flux
+ * @return string
+ */
 function abonnements_insert_head($flux) {
 	$flux .= '<link rel="stylesheet" href="' . _DIR_PLUGIN_ABONNEMENTS . 'css/abonnements_prive.css" type="text/css" />';
 	return $flux;