Changeset 50511 in spip-zone


Ignore:
Timestamp:
Aug 17, 2011, 10:05:16 AM (8 years ago)
Author:
paladin@…
Message:

Documentation code + légère optimisation

File:
1 edited

Legend:

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

    r50510 r50511  
    141141/**
    142142 * Date/time du serveur SQL
    143  * CP-20091207
     143 * @version CP-20091207
    144144 * @return string|bool
    145145 */
     
    852852 *      ($idx == 'sql_where') string ligne sql_where formatee avec OR
    853853 * @version CP-20090111
    854  * @param $idx string
     854 * @param string $idx
    855855 * @return string|array
    856856 */
     
    931931 * -> result du style: array[id_liste] => array(id_auteur, ...)
    932932 * @version CP-20080608
     933 * @param int $id_liste
     934 * @return bool|array
    933935 */
    934936function spiplistes_mod_listes_get_id_auteur ($id_liste) {
     
    957959 * ou tous les moderateurs si $id_auteur == 'tous'
    958960 * @version CP-20090111
     961 * @param bool|string $id_auteur
     962 * @param int $id_liste
     963 * @return bool
    959964 */
    960965function spiplistes_mod_listes_supprimer ($id_auteur, $id_liste) {
     
    979984
    980985/**
     986 * Ajouter un modérateur à une liste
    981987 * @version CP-20080512
     988 * @param int $id_auteur
     989 * @param int $id_liste
     990 * @return bool
    982991 */
    983992function spiplistes_mod_listes_ajouter ($id_auteur, $id_liste) {
     
    10011010
    10021011/**
     1012 * Donne le nombre d emodérateurs d'une liste
    10031013 * @version CP-20080610
     1014 * @param int $id_liste
     1015 * @return bool|int
    10041016 */
    10051017function spiplistes_mod_listes_compter ($id_liste) {
     
    10091021
    10101022/**
    1011  * renvoie tableau id_liste des listes moderees par l'auteur
     1023 * Renvoie tableau id_liste des listes moderees par l'auteur
    10121024 * @version CP-20080620
    10131025 * @return bool|array
     
    10281040
    10291041/**
    1030  * passe propre() sur un texte puis nettoie les trucs rajoutes par spip sur du html
     1042 * Passe propre() sur un texte puis nettoie les trucs rajoutes par spip sur du html
     1043 * @param string $texte
    10311044 * @return string
    10321045 * Remplace spiplistes_courrier_propre() qui est a supprimer apres verif.
     
    10891102}
    10901103
    1091 function spiplistes_titre_propre($titre){
     1104/**
     1105 * Renvoie le titre propre. Longeur limitée par défaut à 128 car.
     1106 * @param string $titre
     1107 * @return string
     1108 */
     1109function spiplistes_titre_propre($titre, $max = 128){
    10921110        $titre = spiplistes_texte_propre($titre);
    1093         $titre = substr($titre, 0, 128); // Au cas ou copie/colle
     1111        $titre = substr($titre, 0, $max); // Au cas ou copie/colle
    10941112        return($titre);
    10951113}
     
    13961414
    13971415/**
    1398  * CP-20080511 20110315
    13991416 * Renvoie la selection pour un seul auteur
     1417 * @version CP-20080511 20110315
    14001418 * @return array OR false
    14011419 */
     
    14081426
    14091427/**
    1410  * CP-20080511
     1428 * Modifie le statut d'un auteur (--> 5poubelle)
     1429 * @version CP-20080511
     1430 * @param string $sql_where du style 'id_auteur=12345'
     1431 * @return bool
    14111432 */
    14121433function spiplistes_auteurs_auteur_delete ($sql_where) {
     
    14261447
    14271448/**
    1428  * CP-20080511
     1449 * @version CP-20080511
    14291450 * @return int|bool
    14301451 */
     
    14351456
    14361457/**
    1437  * CP-20090409
     1458 * @version CP-20090409
    14381459 */
    14391460function spiplistes_auteurs_auteur_valider ($id_auteur, $as_redact = false) {
     
    14541475
    14551476/**
    1456  * CP-20110315
     1477 * @version CP-20110315
    14571478 * @return bool
    14581479 */
     
    14691490
    14701491/**
    1471  * CP-20110321
     1492 * @version CP-20110321
    14721493 * Retourne une version texte pure du nom du site
    14731494 * @return string
     
    17211742}
    17221743
    1723 function spiplistes_str_auteurs ($nb)
    1724 {
     1744/**
     1745 * Renvoie la chaine interprétée au singulier ou au pluriel
     1746 *
     1747 * @version CP-20110817
     1748 * @param int $nb
     1749 * @param string $str_un index de la chaine de lang, singulier
     1750 * @param string $str_pluriel index de la chaine de lang, pluriel
     1751 * @param string $str_aucun index de la chaine de lang, aucun
     1752 * @param string $idx préfixe de la chaine de lang
     1753 * @return string
     1754 */
     1755function spiplistes_str_sing_pluriel ($nb, $str_un, $str_pluriel,
     1756                                                                          $str_aucun = FALSE,
     1757                                                                          $idx = 'spiplistes:'
     1758                                                                          ) {
     1759        $nb = intval($nb);
    17251760        $result =
    17261761                ($nb > 0)
    1727                 ? _T('spiplistes:' . (($nb > 1) ? '_n_auteurs_' : '_1_auteur_'), array('n' => $nb))
    1728                 : 'erreur param'
     1762                ? _T($idx . (($nb > 1) ? $str_pluriel : $str_un), array('n' => $nb))
     1763                : ($str_aucun ? _T($idx . $str_aucun) : '')
    17291764                ;
    1730         return($result);
    1731 }
    1732 
    1733 function spiplistes_str_abonnes ($nb)
    1734 {
    1735         $result =
    1736                 ($nb > 0)
    1737                 ? _T('spiplistes:' . (($nb > 1) ? '_n_abonnes_' : '1_abonne'), array('n' => $nb))
    1738                 : _T('spiplistes:aucun_abo')
    1739                 ;
    1740         return($result);
    1741 }
    1742 
    1743 function spiplistes_str_abonnements ($nb)
    1744 {
    1745         $result =
    1746                 ($nb > 0)
    1747                 ? _T('spiplistes:' . (($nb > 1) ? '_n_abos_' : '_1_abo_'), array('n' => $nb))
    1748                 : _T('spiplistes:aucun_abonmt')
    1749                 ;
    1750         return($result);
    1751 }
    1752 
    1753 
    1754 function spiplistes_str_listes ($nb)
    1755 {
    1756         $result =
    1757                 ($nb > 0)
    1758                 ? _T('spiplistes:' . (($nb > 1) ? 'n_listes' : '1_liste'), array('n' => $nb))
    1759                 : 'erreur param'
    1760                 ;
    1761         return($result);
     1765        return ($result);
     1766}
     1767
     1768function spiplistes_str_auteurs ($nb) {
     1769        return (spiplistes_str_sing_pluriel ($nb, '_1_auteur_', '_n_auteurs_'));
     1770}
     1771
     1772function spiplistes_str_abonnes ($nb) {
     1773        return (spiplistes_str_sing_pluriel ($nb, '1_abonne', '_n_abonnes_', 'aucun_abo'));
     1774}
     1775
     1776function spiplistes_str_abonnements ($nb) {
     1777        return (spiplistes_str_sing_pluriel ($nb, '_1_abo_', '_n_abos_', 'aucun_abonmt'));
     1778}
     1779
     1780function spiplistes_str_listes ($nb) {
     1781        return (spiplistes_str_sing_pluriel ($nb, '1_liste', 'n_listes'));
    17621782}
    17631783
Note: See TracChangeset for help on using the changeset viewer.