Changeset 72979 in spip-zone


Ignore:
Timestamp:
May 24, 2013, 10:50:13 AM (6 years ago)
Author:
marcimat@…
Message:

Un peu de PHPDoc de plus

Location:
_core_/plugins/organiseur
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/organiseur/action/quete_calendrier_prive.php

    r69328 r72979  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion de l'action de quête des événements du calendrier
     15 *
     16 * @package SPIP\Organiseur\Action
     17**/
     18
    1319if (!defined('_ECRIRE_INC_VERSION')) return;
    1420
     
    1622 * Fournir une liste d'"evenements" entre deux dates start et end
    1723 * au format json
    18  * utilise pour l'affichage du calendrier prive et public
     24 *
     25 * Utilisé pour l'affichage du calendrier privé et public
     26 *
     27 * @pipeline_appel quete_calendrier_prive
     28 * @use quete_calendrier_interval_rv()
     29 * @use quete_calendrier_interval()
     30 * @use convert_fullcalendar_quete_calendrier_interval_rv()
     31 * @use convert_fullcalendar_quete_calendrier_interval()
    1932 *
    2033 * @return void
     
    6578
    6679/**
    67  * Convertir une date au format ical renvoyee par quete_calendrier_interval
     80 * Convertir une date au format ical renvoyée par quete_calendrier_interval
    6881 * dans le format attendu par fullcalendar : yyyy-mm-dd H:i:s
     82 *
    6983 * @param $dateical
    7084 * @return string
     
    120134 * dans le format attendu par fullcalendar
    121135 *
     136 * @use convert_dateical()
     137 *
    122138 * @param array $messages
    123139 *     Les événements / messages au format issu de la quete calendrier_interval_rv
  • _core_/plugins/organiseur/inc/quete_calendrier.php

    r69328 r72979  
    1111\***************************************************************************/
    1212
     13/**
     14 * Fonctions de quêtes pour les calendriers : obtient les listes
     15 * des éléments à afficher dans des périodes données
     16 *
     17 * @package SPIP\Organiseur\Fonctions
     18**/
     19
    1320if (!defined('_ECRIRE_INC_VERSION')) return;
    1421
    1522include_spip('inc/filtres');
    16 // http://doc.spip.org/@calendrier_categories
     23
     24
     25/**
     26 * Retourne un nom de classe CSS représentant la catégorie de l'événement
     27 * dans le calendrier
     28 *
     29 * S'appuie soit sur une fonction PHP `generer_calendrier_class()` si elle
     30 * existe, soit à défaut sur le numéro de rubrique.
     31 *
     32 * @param string $table
     33 *     Nom de la table SQL d'où provient l'événement
     34 * @param int $num
     35 *     Identifiant dans la table
     36 * @param string $objet
     37 *     Nom de la clé primaire
     38 * @return string
     39 *     Nom de classe CSS
     40**/
    1741function calendrier_categories($table, $num, $objet)
    1842{
     
    2751}
    2852
    29 // ici on prend en fait le jour, la veille et le lendemain
    30 
    31 // http://doc.spip.org/@quete_calendrier_jour
     53/**
     54 * Pour une date donnée, retourne une période allant de la veille au lendemain
     55 *
     56 * @param int $annee
     57 * @param int $mois
     58 * @param int $jour
     59 * @return array
     60 *     Liste (date de la veille à 0h, date du lendemain à 23h59:59)
     61**/
    3262function quete_calendrier_jour($annee,$mois,$jour) {
    3363        $avant = "'" . date("Y-m-d", mktime(0,0,0,$mois,$jour-1,$annee)) . "'";
     
    3767}
    3868
    39 // retourne un tableau de 2 tableaux indexes par des dates
    40 // - le premier indique les evenements du jour, sans indication de duree
    41 // - le deuxime indique les evenements commencant ce jour, avec indication de duree
    42 
    43 // http://doc.spip.org/@quete_calendrier_interval
     69
     70/**
     71 * Retourne les publications et les messages pour une période donnée
     72 *
     73 * Retourne un tableau de 2 tableaux indéxés par des dates :
     74 * - le premier indique les événements du jour, sans indication de durée
     75 *   (par exemple les publications d'articles)
     76 * - le deuxième indique les événements commençant ce jour, avec indication de durée
     77 *   (par exemple les rendez-vous)
     78 *
     79 * @use quete_calendrier_interval_articles()
     80 * @use quete_calendrier_interval_breves()
     81 * @use quete_calendrier_interval_rubriques()
     82 * @use quete_calendrier_interval_rv()
     83 *
     84 * @param array $limites
     85 *     Liste (date de début, date de fin)
     86 * @return array
     87 *     Liste (événements sans durée, événements avec durée)
     88**/
    4489function quete_calendrier_interval($limites) {
    4590        include_spip('inc/urls');
     
    5297}
    5398
    54 // http://doc.spip.org/@quete_calendrier_interval_forums
     99# 4 fonctions retournant les evenements d'une periode
     100# le tableau retourne est indexe par les balises du format ics
     101# afin qu'il soit facile de produire de tels documents.
     102# L'URL de chacun de ces evenements est celle de l'espace prive
     103# pour faciliter la navigation, ce qu'on obtient utilisant
     104# le 4e argument des fonctions generer_url_ecrire_$table
     105
     106/**
     107 * Retourne la liste des messages de forum (format ICS) écrits dans une période donnée
     108 *
     109 * @param array $limites
     110 *     Liste (date de début, date de fin)
     111 * @param array $evenements
     112 *     Tableau des événements déjà présents qui sera complété par la fonction.
     113 *     Format : `$evenements[$amj][] = Tableau de description ICS`
     114**/
    55115function  quete_calendrier_interval_forums($limites, &$evenements) {
    56116        list($avant, $apres) = $limites;
     
    69129}
    70130
    71 # 3 fonctions retournant les evenements d'une periode
    72 # le tableau retourne est indexe par les balises du format ics
    73 # afin qu'il soit facile de produire de tels documents.
    74 # L'URL de chacun de ces evenements est celle de l'espace prive
    75 # pour faciliter la navigation, ce qu'on obtient utilisant
    76 # le 4e argument des fonctions generer_url_ecrire_$table
    77 
    78 // http://doc.spip.org/@quete_calendrier_interval_articles
     131/**
     132 * Retourne la liste des articles (format ICS) publiés dans une période donnée
     133 *
     134 * @param string $avant
     135 *     Date de début
     136 * @param string $apres
     137 *     Date de fin
     138 * @param array $evenements
     139 *     Tableau des événements déjà présents qui sera complété par la fonction.
     140 *     Format : `$evenements[$amj][] = Tableau de description ICS`
     141**/
    79142function quete_calendrier_interval_articles($avant, $apres, &$evenements) {
    80143
     
    101164}
    102165
    103 // http://doc.spip.org/@quete_calendrier_interval_rubriques
     166/**
     167 * Retourne la liste des rubriques (format ICS) publiées dans une période donnée
     168 *
     169 * @param string $avant
     170 *     Date de début
     171 * @param string $apres
     172 *     Date de fin
     173 * @param array $evenements
     174 *     Tableau des événements déjà présents qui sera complété par la fonction.
     175 *     Format : `$evenements[$amj][] = Tableau de description ICS`
     176**/
    104177function quete_calendrier_interval_rubriques($avant, $apres, &$evenements) {
    105178
     
    118191}
    119192
    120 // http://doc.spip.org/@quete_calendrier_interval_breves
     193/**
     194 * Retourne la liste des brèves (format ICS) publiées dans une période donnée
     195 *
     196 * @param string $avant
     197 *     Date de début
     198 * @param string $apres
     199 *     Date de fin
     200 * @param array $evenements
     201 *     Tableau des événements déjà présents qui sera complété par la fonction.
     202 *     Format : `$evenements[$amj][] = Tableau de description ICS`
     203**/
    121204function quete_calendrier_interval_breves($avant, $apres, &$evenements) {
    122205  $result=sql_select("id_breve, titre, date_heure, id_rubrique", 'spip_breves', "statut='publie' AND date_heure >= $avant AND date_heure < $apres", '', "date_heure");
     
    134217}
    135218
    136 // http://doc.spip.org/@quete_calendrier_interval_rv
     219/**
     220 * Retourne la liste des messages (format ICS) de l'auteur connecté,
     221 * pour une période donnée
     222 *
     223 * @param string $avant
     224 *     Date de début
     225 * @param string $apres
     226 *     Date de fin
     227 * @return array
     228 *     De la forme : `$evt[date][id_message] = Tableau des données ICS`
     229**/
    137230function quete_calendrier_interval_rv($avant, $apres) {
    138231        include_spip('inc/session');
     
    202295}
    203296
    204 // http://doc.spip.org/@quete_calendrier_agenda
     297/**
     298 * Retourne la liste des rendez-vous de l'auteur connecté pour le mois indiqué
     299 *
     300 * @param int $annee
     301 * @param int $mois
     302 * @return array
     303**/
    205304function quete_calendrier_agenda ($annee, $mois) {
    206305        include_spip('inc/session');
  • _core_/plugins/organiseur/organiseur_ieconfig.php

    r57802 r72979  
    11<?php
     2
     3/**
     4 * Déclarations des configurations qui peuvent être sauvegardées
     5 *
     6 * @package SPIP\Organiseur\Pipelines
     7**/
    28
    39if (!defined("_ECRIRE_INC_VERSION")) return;
    410
     11/**
     12 * Ajoute les metas sauvegardables d'Organiseur pour le plugin IEConfig
     13 *
     14 * @pipeline ieconfig_metas
     15 *
     16 * @param array $table
     17 *     Déclaration des sauvegardes
     18 * @return array
     19 *     Déclaration des sauvegardes complétées
     20**/
    521function organiseur_ieconfig_metas($table){
    622        $table['organiseur']['titre'] = _T('titre_messagerie_agenda');
  • _core_/plugins/organiseur/organiseur_pipelines.php

    r69328 r72979  
    1111\***************************************************************************/
    1212
     13/**
     14 * Utilisations de pipelines
     15 *
     16 * @package SPIP\Organiseur\Pipelines
     17**/
     18
    1319if (!defined('_ECRIRE_INC_VERSION')) return;
    1420
    1521
    1622/**
    17  * Lister les tables a ne pas inclure dans un export de BDD
    18  * ici se ramener a tester l'admin restreint est un abus
    19  * car cela presume qu'un admin restreint ne peut pas faire de sauvegarde
    20  * complete, alors que l'intention est d'exclure les messages
    21  * des sauvegardes partielles que peuvent realiser les admin restreint
    22  *
    23  * *a revoir*
    24  *
     23 * Lister les tables à ne pas inclure dans un export de BDD
     24 *
     25 * Ici se ramener à tester l'admin restreint est un abus
     26 * car cela présume qu'un admin restreint ne peut pas faire de sauvegarde
     27 * complète, alors que l'intention est d'exclure les messages
     28 * des sauvegardes partielles que peuvent réaliser les admin restreint
     29 *
     30 * @todo *a revoir*
     31 * @pipeline lister_tables_noexport
     32 *
    2533 * @param array $EXPORT_tables_noexport
    2634 * @return array
     
    3745 * Optimiser les liens morts dans la base de donnees
    3846 *
     47 * @pipeline optimiser_base_disparus
     48 *
    3949 * @param array $flux
    4050 * @return array
     
    6171 * concerne par l'appel
    6272 *
     73 * @pipeline alertes_auteur
     74 *
    6375 * @param array $flux
    6476 * @return array
     
    8597 * avec un auteur (sur sa page)
    8698 *
     99 * @pipeline affiche_auteurs_interventions
     100 *
    87101 * @param array $flux
    88102 * @return array
     
    104118
    105119/**
    106  * Declarer les metas de configuration de l'agenda/messagerie
     120 * Déclarer les metas de configuration de l'agenda/messagerie
     121 *
     122 * @pipeline configurer_liste_metas
    107123 * @param array $metas
    108  * @return array
     124 *     Couples nom de la méta => valeur par défaut
     125 * @return array
     126 *    Couples nom de la méta => valeur par défaut
    109127 */
    110128function organiseur_configurer_liste_metas($metas){
     
    114132
    115133/**
    116  * Inserer la css de l'agenda dans l'espace prive (hum)
     134 * Insérer la css de l'agenda dans l'espace privé (hum)
     135 *
     136 * @pipeline header_prive
    117137 * @param string $head
    118138 * @return string
     
    130150 * Afficher agenda, messages et annonces sur la page d'accueil
    131151 *
     152 * @pipeline affiche_droite
    132153 * @param array $flux
    133154 * @return array
     
    147168
    148169/**
    149  * Afficher le formulaire de configuration sur la page concernee
    150  *
     170 * Afficher le formulaire de configuration sur la page concernée
     171 *
     172 * @pipeline affiche_milieu
    151173 * @param array $flux
    152174 * @return array
     
    166188 * Diffuser un message qui passe en publie (== a envoyer)
    167189 *
     190 * @pipeline post_edition
    168191 * @param array $flux
    169192 * @return array
Note: See TracChangeset for help on using the changeset viewer.