Changeset 47621 in spip-zone


Ignore:
Timestamp:
May 10, 2011, 7:42:37 AM (10 years ago)
Author:
paladin@…
Message:

documentation du code

File:
1 edited

Legend:

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

    r47553 r47621  
    7979}
    8080
    81 /* function privee
     81/**
     82 * function privee
    8283 * multi_queries mysql n'est pas en mesure de le faire en natif :-(
    8384 * A tranformer le jour ou mysql gerera correctement le multi_query
     
    9798}
    9899
    99 //CP-20080508: renvoie OK ou ERR entre crochet
    100 // sert principalement pour les log
     100/**
     101 * @version CP-20080508
     102 * renvoie OK ou ERR entre crochet
     103 * sert principalement pour les log
     104 * @return string
     105 */
    101106function spiplistes_str_ok_error ($statut) {
    102107        return("[".(($statut != false) ? "OK" : "ERR")."]");
     
    112117}
    113118
    114 //CP-20080508
     119/**
     120 * @version CP-20080508
     121 */
    115122function spiplistes_sql_compter ($table, $sql_whereq) {
    116123        $sql_result = intval(sql_countsel($table, $sql_whereq));
     
    118125}
    119126
    120 // CP-20080511
     127/**
     128 * @version CP-20080511
     129 */
    121130function spiplistes_courriers_statut_compter ($statut='tous') {
    122131        $sql_where = spiplistes_listes_sql_where_or(
     
    132141 * Date/time du serveur SQL
    133142 * CP-20091207
    134  * @return string or bool
     143 * @return string|bool
    135144 */
    136145function spiplistes_sql_now ()
     
    143152}
    144153
    145 // CP-20080510
     154/**
     155 * @version CP-20080510
     156 */
    146157function spiplistes_courriers_casier_premier ($sql_select, $sql_whereq) {
    147158        return(sql_select(
     
    223234} // spiplistes_abonnements_ajouter()
    224235
    225 // desabonner des listes (CP-20071016)
    226 // $listes_statuts : array (statuts des listes,..)
     236/**
     237 * desabonner des listes
     238 * @version CP-20071016
     239 */
    227240function spiplistes_abonnements_desabonner_statut ($id_auteur, $listes_statuts) {
    228241        if(($id_auteur = intval($id_auteur)) && count($listes_statuts)) {
     
    243256
    244257
    245 //CP-20080512 : supprimer des abonnes de la table des abonnements
     258/**
     259 * supprimer des abonnes de la table des abonnements
     260 * @version CP-20080512
     261 */
    246262function spiplistes_abonnements_auteurs_supprimer ($auteur_statut) {
    247263        $auteur_statut = "statut=".sql_quote($auteur_statut);
     
    262278}
    263279
    264 /*
    265  * CP-20080330 : renvoie la liste des abonnements pour id_auteur
     280/**
     281 * renvoie la liste des abonnements pour id_auteur
     282 * @version CP-20080330
     283 * @param int $id_auteur
     284 * @param bool $avec_titre
    266285 * @return tableau d'id_listes. La valeur est titre si $avec_titre true, sinon id_liste
    267  * @param $id_auteur int
    268  * @param $avec_titre bool
    269286 */
    270287function spiplistes_abonnements_listes_auteur ($id_auteur, $avec_titre = false) {
     
    295312}
    296313
    297 // CP-20080324 : desabonner un id_auteur d'une id_liste
    298 // CP-20080508 : ou de toutes les listes si $id_liste = 'toutes'
    299 // CP-20090111: ou tous les abonnes si id_auteur == 'tous'
    300 // CP-20090410: ou une serie si array
     314/**
     315 * desabonner un id_auteur d'une id_liste
     316 * ou de toutes les listes si $id_liste = 'toutes'
     317 * ou tous les abonnes si id_auteur == 'tous'
     318 * ou une serie si array
     319 * @version CP-20090410
     320 */
    301321function spiplistes_abonnements_auteur_desabonner ($id_auteur, $id_liste = false)
    302322{
     
    343363}
    344364
    345 //CP-20080512 : supprimer des abonnements
     365/**
     366 * supprimer des abonnements
     367 * @version CP-20080512
     368 */
    346369function spiplistes_abonnements_supprimer ($sql_whereq) {
    347370        return(sql_delete('spip_auteurs_listes', $sql_whereq));
    348371}
    349372
    350 
    351 //CP-20080508 : dans la table des abonnements
     373/**
     374 * dans la table des abonnements
     375 * @version CP-20080508
     376 */
    352377function spiplistes_abonnements_compter ($sql_whereq = "") {
    353378        return(spiplistes_sql_compter("spip_auteurs_listes", $sql_whereq));
     
    387412
    388413/**
    389  ******************************************************************************
    390         Les fonctions spiplistes_abonnements_*() concernent les listes
    391        
    392         Table cible : spip_listes
    393        
    394  ******************************************************************************
    395  */
    396 
    397 //CP-20080508 : dans la table des listes
    398 function spiplistes_listes_compter ($sql_whereq = "") {
    399         return(spiplistes_sql_compter("spip_listes", $sql_whereq));
    400 }
    401 
    402 //CP-20081228
    403 //Donner le nombre d'abonnés (pour une liste)
    404 //qui ont un vrai format de réception (html ou texte)
    405 // et une adresse mail valide
    406 function spiplistes_listes_vrais_abos_compter ($id_liste) {
     414 * Donne le nombre d'abonnés (pour une liste)
     415 * qui ont un vrai format de réception (html ou texte)
     416 * et une adresse mail valide
     417 * @version CP-20081228
     418 * @return int
     419 */
     420function spiplistes_abonnements_vrais_compter ($id_liste) {
    407421        if($id_liste = intval($id_liste)) {
    408422                // SELECT COUNT(l.id_auteur) AS nb
     
    422436                $sql_result = sql_select($sql_select, $sql_from, $sql_where);
    423437                if($sql_result === false) {
    424                         spiplistes_sqlerror_log("spiplistes_listes_vrais_abos_compter()");
     438                        spiplistes_sqlerror_log("spiplistes_abonnements_vrais_compter()");
    425439                }
    426440                if($row = sql_fetch($sql_result)) {
     
    431445}
    432446
    433 // CP-20080501
     447/**
     448 ******************************************************************************
     449        Les fonctions spiplistes_listes_*() concernent les listes
     450       
     451        Table cible : spip_listes
     452       
     453 ******************************************************************************
     454 */
     455
     456/**
     457 * dans la table des listes
     458 * @version CP-20080508
     459 */
     460function spiplistes_listes_compter ($sql_whereq = "") {
     461        return(spiplistes_sql_compter("spip_listes", $sql_whereq));
     462}
     463
     464/**
     465 * @version CP-20080501
     466 */
    434467function spiplistes_listes_liste_modifier ($id_liste, $array_set) {
    435468        return(
     
    442475}
    443476
    444 // CP-20080501
     477/**
     478 * @version CP-20080501
     479 */
    445480function spiplistes_listes_liste_supprimer ($id_liste) {
    446481        $sql_where = "id_liste=".sql_quote(intval($id_liste));
     
    452487}
    453488
    454 //CP-20080512
     489/**
     490 * @version CP-20080512
     491 */
    455492function spiplistes_listes_liste_creer ($statut, $lang, $titre, $texte, $pied_page) {
    456493        global $connect_id_auteur;
     
    476513}
    477514
    478 //CP-20080602
    479 // renvoie tableau de id_auteurs abonnes a une liste
     515/**
     516 * renvoie tableau de id_auteurs abonnes a une liste
     517 * @version CP-20080602
     518 */
    480519function spiplistes_listes_liste_abo_ids ($id_liste) {
    481520        $sql_result = sql_select('id_auteur', 'spip_auteurs_listes', "id_liste=".sql_quote($id_liste), '', array('id_auteur'));
     
    492531 *      sinon, nombre total d'abonnements (nb lignes dans la table)
    493532 * @param $preciser. Si true, renvoie tableau total et formats
    494  * @return int ou array
    495  * */
     533 * @return int|array
     534 */
    496535function spiplistes_listes_nb_abonnes_compter ($id_liste = 0, $preciser = false)
    497536{
     
    535574}
    536575
    537 //CP-20080509: renvoie email emetteur d'une liste
     576/**
     577 * renvoie email emetteur d'une liste
     578 * @version CP-20080509
     579 */
    538580function spiplistes_listes_email_emetteur ($id_liste = 0) {
    539581        $id_liste = intval($id_liste);
     
    556598}
    557599
    558 //CP-20080511
     600/**
     601 * @version CP-20080511
     602 */
    559603function spiplistes_listes_liste_fetsel ($id_liste, $keys = "*") {
    560604        $id_liste = intval($id_liste);
     
    562606}
    563607
    564 //CP-20081116
     608/**
     609 * @version CP-20081116
     610 */
    565611function spiplistes_listes_liste_statut ($id_liste) {
    566612        return(spiplistes_listes_liste_fetsel($id_liste, 'statut'));
    567613}
    568614
    569 // CP-20080505 : renvoie array sql_where des listes publiees
     615/**
     616 * renvoie array sql_where des listes publiees
     617 * @version CP-20080505
     618 */
    570619function spiplistes_listes_sql_where_or ($listes) {
    571620        return("statut=".implode(" OR statut=", array_map("sql_quote", explode(";", $listes))));
    572621}
    573622
    574 //taille d'une chaine sans saut de lignes ni espaces ni punct
     623/**
     624 * taille d'une chaine sans saut de lignes ni espaces ni punct
     625 */
    575626function spiplistes_strlen($out){
    576627        $out = preg_replace("/([[:space:]]|[[:punct:]])+/", "", $out);
     
    578629}
    579630
    580 //CP-20080508 : dans la queue d'envoi des courriers
     631/**
     632 * dans la queue d'envoi des courriers
     633 * @version CP-20080508
     634 */
    581635function spiplistes_courriers_en_queue_compter ($sql_whereq = "") {
    582636        // demande le nombre de courriers dans la queue
     
    586640}
    587641
    588 // CP-20080510
     642/**
     643 * @version CP-20080510
     644 */
    589645function spiplistes_courriers_en_queue_modifier ($array_set, $sql_whereq) {
    590646        return(
     
    598654
    599655
    600 // CP-20080510
     656/**
     657 * @version CP-20080510
     658 */
    601659function spiplistes_courriers_en_queue_supprimer ($sql_whereq) {
    602660        if(($result = sql_delete('spip_auteurs_courriers', $sql_whereq)) === false) {
     
    606664}
    607665
    608 // CP-20080621
    609 // la premiere etiquette sur le tas
     666/**
     667 *l a premiere etiquette sur le tas
     668 * @version CP-20080621
     669 */
    610670function spiplistes_courriers_en_queue_premier ($select, $where) {
    611671        return(
     
    641701
    642702
    643 // suspend les abonnements d'un compte
     703/**
     704 * suspend les abonnements d'un compte
     705 */
    644706function spiplistes_format_abo_suspendre ($id_auteur) {
    645707        return(spiplistes_format_abo_modifier($id_auteur));
    646708}
    647709
    648 //CP2008111 supprimer le format d'un id_auteur
    649 // CP-20090111: si $id_auteur == 'tous', supprimer tous les formats
     710/**
     711 * supprimer le format d'un id_auteur
     712 * si $id_auteur == 'tous', supprimer tous les formats
     713 * @version CP-20090111
     714 */
    650715function spiplistes_format_abo_supprimer ($id_auteur) {
    651716        $sql_table = "spip_auteurs_elargis";
     
    797862 */
    798863
    799 // renvoie ID du moderateur de la liste
    800 // CP-20080608 : ou de toutes les listes si $id_liste = 'toutes'
    801 // -> result du style: array[id_liste] => array(id_auteur, ...)
     864/**
     865 * renvoie ID du moderateur de la liste
     866 * ou de toutes les listes si $id_liste = 'toutes'
     867 * -> result du style: array[id_liste] => array(id_auteur, ...)
     868 * @version CP-20080608
     869 */
    802870function spiplistes_mod_listes_get_id_auteur ($id_liste) {
    803871        $sql_from = 'spip_auteurs_mod_listes';
     
    821889}
    822890
    823 // CP-20080503: supprime un ou + moderateurs d'une liste
    824 // CP-20090111: ou tous les moderateurs si $id_auteur == 'tous'
     891/**
     892 * supprime un ou + moderateurs d'une liste
     893 * ou tous les moderateurs si $id_auteur == 'tous'
     894 * @version CP-20090111
     895 */
    825896function spiplistes_mod_listes_supprimer ($id_auteur, $id_liste) {
    826897        if(($id_auteur = intval($id_auteur)) > 0) {
     
    843914}
    844915
    845 //CP-20080512
     916/**
     917 * @version CP-20080512
     918 */
    846919function spiplistes_mod_listes_ajouter ($id_auteur, $id_liste) {
    847920        if(($id_liste = intval($id_liste)) > 0) {
     
    863936}
    864937
    865 //CP-2080610
     938/**
     939 * @version CP-20080610
     940 */
    866941function spiplistes_mod_listes_compter ($id_liste) {
    867942        $n = sql_fetch(sql_select("COUNT(*) AS n", "spip_auteurs_mod_listes", "id_liste=".sql_quote($id_liste)));
     
    869944}
    870945
    871 //CP-20080620
    872 // renvoie tableau id_liste des listes moderees par l'auteur
     946/**
     947 * renvoie tableau id_liste des listes moderees par l'auteur
     948 * @version CP-20080620
     949 */
    873950function spiplistes_mod_listes_id_auteur ($id_auteur) {
    874951        $result = false;
     
    9531030}
    9541031
    955 /*
    956  * CP-20081128
     1032/**
    9571033 * Recherche les différentes versions de patron possibles
    9581034 * <patron>._texte.en patron texte anglais
     
    9601036 * <patron>.en patron anglais
    9611037 * <patron> patron generique
    962  * @return string le chemin du patron si patron trouve' ou FALSE si non trouve'
     1038 * @version CP-20081128
    9631039 * @param $path_patron string
    9641040 * @param $lang string
    9651041 * @param $chercher_texte bool si TRUE, chercher la version texte du patron
     1042 * @return string le chemin du patron si patron trouve' ou FALSE si non trouve'
    9661043 * @todo verifier presence de lang dans les appels a cette fonction
    9671044 */
     
    9871064
    9881065
    989 /*
    990  * CP-20090427
     1066/**
    9911067 * Assembler/calculer un patron
    992  * @return array le resultat html et texte seul dans un tableau
     1068 * @version CP-20090427
    9931069 * @param $patron string nom du patron
    9941070 * @param $contexte array
     1071 * @return array le resultat html et texte seul dans un tableau
    9951072 */
    9961073function spiplistes_assembler_patron ($path_patron, $contexte) {
     
    10321109}
    10331110
    1034 /* donne contenu tampon au format html (CP-20071013) et texte
     1111/**
     1112 * donne contenu tampon au format html (CP-20071013) et texte
    10351113 * @return array (string $html, string $texte)
    10361114 */
     
    11041182 */
    11051183
    1106 // CP-20080503
    1107 // soit update cookie du cookie transmis
    1108 // soit update cookie de l'email transmis
     1184/**
     1185 * @version CP-20080503
     1186 * soit update cookie du cookie transmis
     1187 * soit update cookie de l'email transmis
     1188 */
    11091189function spiplistes_auteurs_cookie_oubli_updateq ($cookie_oubli, $where, $where_is_cookie = false) {
    11101190        if(is_string($where)) {
     
    11151195}
    11161196
    1117 // CP-20080629
     1197/**
     1198 * @version CP-20080629
     1199 * soit update cookie du cookie transmis
     1200 * soit update cookie de l'email transmis
     1201 */
    11181202function spiplistes_date_heure_valide ($date_heure) {
    11191203        $date_array = recup_date($date_heure);
     
    11261210}
    11271211
    1128 //CP-200080519
    1129 // Nombre total d'auteurs (ou visiteur, ou perso) elligibles
    1130 // Nota: un compte 'nouveau' est un compte visiteur (inscription) qui ne s'est pas encore connecté
    1131 // Nota2: un compte créé via l'espace privé mais pas encore connecté
    1132 // n'a pas le statut 'nouveau' mais celui de son groupe
     1212/**
     1213 * Nombre total d'auteurs (ou visiteur, ou perso) elligibles
     1214 * Nota: un compte 'nouveau' est un compte visiteur (inscription) qui ne s'est pas encore connecté
     1215 * Nota2: un compte créé via l'espace privé mais pas encore connecté
     1216 * n'a pas le statut 'nouveau' mais celui de son groupe
     1217 * @version CP-200080519
     1218 */
    11331219function spiplistes_auteurs_elligibles_compter ()
    11341220{
     
    11451231}
    11461232
    1147 //CP-200080519
    1148 //Total des auteurs qui ne sont pas abonnes a une liste
     1233/**
     1234 * Total des auteurs qui ne sont pas abonnes a une liste
     1235 * @version CP-200080519
     1236 */
    11491237function spiplistes_auteurs_non_abonnes_compter ()
    11501238{
     
    11791267}
    11801268
    1181 //CP-20080511
     1269/**
     1270 * CP-20080511
     1271 */
    11821272function spiplistes_auteurs_auteur_delete ($sql_where) {
    11831273        // détruire ou mettre à la poubelle ?
     
    11971287/**
    11981288 * CP-20080511
    1199  * @return int OR boolean
     1289 * @return int|bool
    12001290 */
    12011291function spiplistes_auteurs_auteur_insertq ($champs_array) {
     
    12041294}
    12051295
    1206 //CP-20090409
     1296/**
     1297 * CP-20090409
     1298 */
    12071299function spiplistes_auteurs_auteur_valider ($id_auteur, $as_redact = false) {
    12081300        if($id_auteur = intval($id_auteur)) {
     
    12661358
    12671359/**
    1268  * CP-20110321
     1360 * @version CP-20110321
    12691361 * @return string
    12701362 */
     
    12771369}
    12781370
    1279 //CP-20080511
    1280 // CP-20090111: utiliser l'api pour pouvoir envoyer par smtp si besoin
     1371/**
     1372 * utiliser l'api pour pouvoir envoyer par smtp si besoin
     1373 * @version CP-20090111
     1374 */
    12811375function spiplistes_envoyer_mail ($to, $subject, $message, $from = false, $headers = '', $format = 'texte') {
    12821376       
     
    13591453}
    13601454
    1361 /*
     1455/**
    13621456 * Creation du login a partir de l email donne'
    13631457 * @return string or false if error
     
    13921486}
    13931487
    1394 /*
    1395 */
     1488/**
     1489 * Donne la langue de la liste
     1490 */
    13961491function spiplistes_listes_langue ($id_liste) {
    13971492        if(($id_liste = intval($id_liste)) > 0) {
     
    14161511 * Lire la valeur de $key dans les prefs (meta)
    14171512 * Si erreur (manquante) appliquer $defaut
    1418  **/
     1513 */
    14191514function spiplistes_pref_lire_defaut ($key, $default)
    14201515{
Note: See TracChangeset for help on using the changeset viewer.