Changeset 50563 in spip-zone


Ignore:
Timestamp:
Aug 19, 2011, 12:14:53 PM (9 years ago)
Author:
paladin@…
Message:

documentation phpdoc

Location:
_plugins_/spip-listes/spip-listes_1_9_3/inc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_listes_selectionner_auteur.php

    r48231 r50563  
    5757define('_SPIPLISTES_ID_FROM_ELLIGIBL', 'form-recherche-abo-elligibles');
    5858
    59 //CP-20080603
    60 // renvoie un tableau d'auteurs, du style
    61 // $result['1comite'][$id_auteur] = nom
    62 // + le nombre d'elligibles
    63 // si $id_liste == 0, liste complete
    64 // sinon, ceux non abonnes a la liste
    65 // Si liste privee, uiquement redacs
    66 // Si liste publique, tout le monde (sauf si deja abonne)
    67 // $nb_non_abonnes = nombre d'elligibles trouves
    68 // Pour recuperer le resultat :
    69 //   list($non_abonnes, $nb_non_abonnes) = spiplistes_listes_auteurs_elligibles($id_liste, $statut);
     59/**
     60 * Renvoie un tableau d'auteurs, du style
     61 * $result['1comite'][$id_auteur] = nom
     62 * + le nombre d'elligibles
     63 * si $id_liste == 0, liste complete
     64 * sinon, ceux non abonnes a la liste
     65 *
     66 * Si liste privee, uiquement redacs
     67 * Si liste publique, tout le monde (sauf si deja abonne)
     68 * $nb_non_abonnes = nombre d'elligibles trouves
     69 * Pour recuperer le resultat :
     70 *   list($non_abonnes, $nb_non_abonnes) = spiplistes_listes_auteurs_elligibles($id_liste, $statut);
     71 *
     72 * @version CP-20080603
     73 * @param int $id_liste
     74 * @param string $statut_liste
     75 * @param string $faire
     76 * @return array
     77 */
    7078function spiplistes_listes_auteurs_elligibles ($id_liste, $statut_liste = '', $faire = '') {
    7179        $nb_auteurs = 0;
     
    107115
    108116/**
    109  * @versin CP-20080603
    110  * @return la boite en liste des abonnes a une liste
    111  *      si $id_liste == 0, liste tous les abonnements
     117 * @version CP-20080603
    112118 * @param $id_liste entier
    113119 * @param $statut_liste staut ou false
     
    115121 * @param $debut id_auteur du premier affiche
    116122 * @param $script_retour string
     123 * @return la boite en liste des abonnes a une liste
     124 *      si $id_liste == 0, liste tous les abonnements
    117125 */
    118126function spiplistes_listes_boite_abonnes ($id_liste, $statut_liste, $tri, $debut, $script_retour) {
     
    643651}
    644652
    645 //CP-20080603
    646 // met en forme le resultat de spiplistes_listes_auteurs_elligibles()
    647 // retourne liste des elligibles sous forme de select, selecteur_spip ou recherche
    648 // si trop nombreux.
     653/**
     654 * Met en forme le resultat de spiplistes_listes_auteurs_elligibles()
     655 * retourne liste des elligibles sous forme de select, selecteur_spip ou recherche
     656 * si trop nombreux.
     657 *
     658 * @version CP-20080603
     659 */
    649660function spiplistes_listes_selectionner_elligibles (
    650661        $non_abonnes
     
    781792}
    782793
     794/**
     795 * Renvoie le code HTML pour un sélecteur d'elligibles.
     796 *   Un elligible est un auteur qui peut être abonné à une liste
     797 *   ou un modérateur.
     798 *
     799 * @todo vérifier compatibiliét optgroup
     800 * @param array $elligibles
     801 * @param int $nb_elligibles
     802 * @param string $type_ajout
     803 * @return string
     804 */
    783805function spiplistes_elligibles_select ($elligibles, $nb_elligibles, $type_ajout = 'abo') {
    784806        $t_statut = array(
     
    789811        );
    790812        $legend = ($type_ajout == 'abo') ? 'abon_ajouter' : 'ajouter_un_moderateur';
    791         // si un seul, activer plutot la selection par la souris
    792         // onchange n'est pas transmis si un seul 'option'
     813        /**
     814         * Si un seul, activer plutot la selection par la souris
     815         * onchange n'est pas transmis si un seul 'option'
     816         */
    793817        $onevent = ($nb_elligibles == 1) ? "onmousedown" : "onchange";
    794818        $select_abo = ""
     
    808832}
    809833
    810 //CP20080603
    811 // la boite complete (abonnes et elligibles) enveloppee pour ajax
     834/**
     835 * La boite complete (abonnes et elligibles) enveloppee pour ajax
     836 *
     837 * @version CP20080603
     838 * @param int $id_liste
     839 * @param string $statut_liste
     840 * @param string $tri
     841 * @param int $debut
     842 * @param string $script_retour
     843 * @return string
     844 */
    812845function spiplistes_listes_boite_abonnements ($id_liste, $statut_liste, $tri, $debut, $script_retour) {
    813846
     
    821854}
    822855
    823 //CP-20081117
    824 // boite construction des elligibles. Appelee aussi via action/ajax
     856/**
     857 * Boite construction des elligibles. Appelee aussi via action/ajax
     858 *
     859 * @param int $id_liste
     860 * @param string $statut_liste
     861 * @param string $tri
     862 * @param int $debut
     863 * @version CP-20081117
     864 * @return string
     865 */
    825866function spiplistes_listes_boite_elligibles ($id_liste, $statut_liste, $tri, $debut) {
    826867       
     
    845886}
    846887
    847 //CP-20080610
    848 // boite des moderateurs
     888
     889/**
     890 * Boite des moderateurs
     891 *
     892 * @version CP-20080610
     893 * @param int $id_liste
     894 * @param string $script_retour
     895 * @param string $id_conteneur
     896 * @return string
     897 */
    849898function spiplistes_listes_boite_moderateurs ($id_liste, $script_retour, $id_conteneur)
    850899{
     
    912961} //
    913962
    914 
     963/**
     964 * {@link spiplistes_corrige_img_pack}
     965 */
    915966function spiplistes_bonhomme_statut ($row) {
    916967        return(spiplistes_corrige_img_pack(bonhomme_statut($row)));
    917968}
    918969
    919 // Lorsqu'appele par ?action (ajax), perd la position
    920 // corrige le lien relatif
     970/**
     971 * Lorsqu'appele par ?action (ajax), perd la position
     972 * corrige le lien relatif
     973 *
     974 * @param string $img
     975 * @return string
     976 */
    921977function spiplistes_corrige_img_pack ($img) {
    922978        if(preg_match(",^<img src='dist/images,", $img)) {
  • _plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_mail.inc.php

    r49406 r50563  
    1212
    1313/**
    14  * @return boolean
     14 * @return bool
    1515 */
    1616function spiplistes_utiliser_facteur()
  • _plugins_/spip-listes/spip-listes_1_9_3/inc/spiplistes_naviguer_paniers.php

    r47066 r50563  
    11<?php
    22/**
     3 * Affiche gauche
     4 * Menu de navigation entre les paniers de courriers ou listes
     5 *
    36 * @version Original From SPIP-Listes-V :: Id: spiplistes_naviguer_paniers.php paladin@quesaco.org
    47 * @package spiplistes
     
    1114
    1215include_spip('inc/spiplistes_api_globales');
    13 
    14 /*
    15         Affiche gauche
    16         Menu de navigation entre les paniers de courriers ou listes
    17 */
    1816
    1917function spiplistes_naviguer_paniers ($titre, $sql_from, $les_statuts, $script_exec) {
     
    104102}
    105103
    106 ?>
Note: See TracChangeset for help on using the changeset viewer.