Changeset 122839 in spip-zone


Ignore:
Timestamp:
Mar 4, 2020, 4:17:23 PM (15 months ago)
Author:
vincent.callies@…
Message:

Davantage de documentation du code (sans changement de programmation)

Location:
_plugins_/pensebetes/trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/pensebetes/trunk/action/supprimer_pensebete.php

    r119031 r122839  
    1111 
    1212if (!defined("_ECRIRE_INC_VERSION")) return;
     13
     14/**
     15 * Action pour supprimer un Pense-bête
     16 *
     17 * @param  int    $id_pensebete    Identifiant de l'objet
     18 * @return void
     19**/
    1320 
    1421function action_supprimer_pensebete_dist($id_pensebete=null){
  • _plugins_/pensebetes/trunk/formulaires/editer_pensebete.php

    r119120 r122839  
    124124 * Déclarer les champs postés et y intégrer les valeurs par défaut
    125125 *
    126  * @param string $associer_objet
    127  *     Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
    128  *     tel que 'article|3'
     126 * @param int|string $id_pensebete identifiant de l'objet ou 'new' si absent.
     127 * @param int $id_rubrique identifiant de la rubrique.
     128 * @param string $retour lien pour le retour.
     129 * @param string $associer_objet
     130 *     Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
     131 *     tel que 'article|3'
     132 * @param int $lier_trad
     133 * @param string $config_fonc
     134 * @param array $row
     135 * @param array $hidden
    129136 * @uses formulaires_editer_objet_charger()
    130137 * @uses mes_saisies_pensebete()
     
    160167/**
    161168 * Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite
     169 *
     170 * @param int|string $id_pensebete identifiant de l'objet ou 'new' si absent.
     171 * @param int $id_rubrique identifiant de la rubrique.
     172 * @param string $retour lien pour le retour.
     173 * @param string $associer_objet
     174 *     Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
     175 *     tel que 'article|3'
     176 * @param int $lier_trad
     177 * @param string $config_fonc
     178 * @param array $row
     179 * @param array $hidden
    162180 */
    163181function formulaires_editer_pensebete_identifier_dist($id_pensebete='new', $id_rubrique=0, $retour='', $associer_objet, $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     
    168186 * Vérification du formulaire d'édition de pensebete
    169187 *
     188 * @param int|string $id_pensebete identifiant de l'objet ou 'new' si absent.
     189 * @param int $id_rubrique identifiant de la rubrique.
     190 * @param string $retour lien pour le retour.
     191 * @param string $associer_objet
     192 *     Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
     193 *     tel que 'article|3'
     194 * @param int $lier_trad
     195 * @param string $config_fonc
     196 * @param array $row
     197 * @param array $hidden
    170198 * @uses formulaires_editer_objet_verifier()
    171199 * @uses saisies_verifier()
     
    193221 * Le traitement effectue une mise à zéro de l'id_auteur pour éviter des associations considérées comme inutiles.
    194222 *
     223 * @param int|string $id_pensebete identifiant de l'objet ou 'new' si absent.
     224 * @param int $id_rubrique identifiant de la rubrique.
     225 * @param string $retour lien pour le retour.
     226 * @param string $associer_objet
     227 *     Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
     228 *     tel que 'article|3'
     229 * @param int $lier_trad
     230 * @param string $config_fonc
     231 * @param array $row
     232 * @param array $hidden
    195233 * @uses formulaires_editer_objet_traiter()
    196234 * @uses objet_associer()
  • _plugins_/pensebetes/trunk/pensebetes_administrations.php

    r119078 r122839  
    1414if (!defined('_ECRIRE_INC_VERSION')) return;
    1515
     16/**
     17 * Création et mise à jour du plugin Pensebetes
     18 *
     19 * @param  string $nom_meta_base_version version du schéma de données du plugin installé
     20 * @param  string $version_cible Version déclarée dans paquet.xml
     21 * @return void
     22**/
    1623
    1724function pensebetes_upgrade($nom_meta_base_version, $version_cible){
     
    3340}
    3441
     42/**
     43 * Faire le ménage lors de la désinstallation du plugin Pensebetes
     44 *
     45 * @param  string $nom_meta_base_version version du schéma de données du plugin installé
     46 * @return void
     47**/
     48
    3549function pensebetes_vider_tables($nom_meta_base_version) {
    3650        sql_drop_table("spip_pensebetes");
  • _plugins_/pensebetes/trunk/pensebetes_autorisations.php

    r119025 r122839  
    2121}
    2222
     23/**
     24 * Autorisation d'associer un pensebete
     25 *
     26 * @param  string $faire Action demandée
     27 * @param  string $type  Type d'objet sur lequel appliquer l'action
     28 * @param  int    $id    Identifiant de l'objet
     29 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     30 * @param  array  $opt   Options de cette autorisation
     31 * @return bool          true s'il a le droit, false sinon
     32**/
    2333
    2434function autoriser_associerpensebetes_dist($faire, $type, $id, $qui, $opt) {
Note: See TracChangeset for help on using the changeset viewer.