Changeset 69933 in spip-zone


Ignore:
Timestamp:
Feb 15, 2013, 7:22:07 PM (7 years ago)
Author:
marcimat@…
Message:

Du PHPDoc

Location:
_core_/plugins/forum
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/forum/base/forum.php

    r69328 r69933  
    1111\***************************************************************************/
    1212
     13/**
     14 * Déclarations des tables et objets au compilateur
     15 *
     16 * @package SPIP\Core\Pipelines
     17**/
     18
    1319if (!defined('_ECRIRE_INC_VERSION')) return;
    1420
     
    1622 * Interfaces de la table forum pour le compilateur
    1723 *
     24 * @pipeline declarer_tables_interfaces
    1825 * @param array $interfaces
    1926 * @return array $interfaces
     
    5461 * Déclaration de la table spip_forum et de l'objet forum
    5562 *
     63 * @pipeline declarer_tables_objets_sql
    5664 * @param array $tables Tableau des objets déclarés
    5765 * @return array $tables Tableau des objets complété
  • _core_/plugins/forum/forum_administrations.php

    r69328 r69933  
    1010 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
    1111\***************************************************************************/
     12
     13/**
     14 * Fichier gérant l'installation et désinstallation du plugin
     15 *
     16 * @package SPIP\Forum\Installation
     17**/
    1218
    1319if (!defined("_ECRIRE_INC_VERSION")) return;
     
    8086
    8187/**
    82  * Desinstallation/suppression des tables forum
     88 * Désinstallation/suppression des tables forum
    8389 *
    8490 * @param string $nom_meta_base_version
  • _core_/plugins/forum/forum_autoriser.php

    r69328 r69933  
    1111\***************************************************************************/
    1212
     13/**
     14 * Définit les autorisations du plugin forum
     15 *
     16 * @package SPIP\Forum\Autorisations
     17**/
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
    15 // declarer la fonction du pipeline
     20/**
     21 * Fonction d'appel pour le pipeline
     22 * @pipeline autoriser
     23 */
    1624function forum_autoriser(){}
    1725
    18 
     26/**
     27 * Autorisation de voir l'élément «forums internes» dans le menu
     28 *
     29 * @param  string $faire Action demandée
     30 * @param  string $type  Type d'objet sur lequel appliquer l'action
     31 * @param  int    $id    Identifiant de l'objet
     32 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     33 * @param  array  $opt   Options de cette autorisation
     34 * @return bool          true s'il a le droit, false sinon
     35**/
    1936function autoriser_foruminternesuivi_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
    2037        if ((($GLOBALS['meta']['forum_prive'] == 'non') && ($GLOBALS['meta']['forum_prive_admin'] == 'non'))
     
    2441}
    2542
     43/**
     44 * Autorisation de voir l'élément «suivi des forums» dans le menu
     45 *
     46 * @param  string $faire Action demandée
     47 * @param  string $type  Type d'objet sur lequel appliquer l'action
     48 * @param  int    $id    Identifiant de l'objet
     49 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     50 * @param  array  $opt   Options de cette autorisation
     51 * @return bool          true s'il a le droit, false sinon
     52**/
    2653function autoriser_forumreactions_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
    2754        return (sql_countsel('spip_forum') && autoriser('publierdans','rubrique',_request('id_rubrique')));
     
    2956
    3057
    31 // Moderer le forum ?
    32 // = modifier l'objet correspondant (si forum attache a un objet)
    33 // = droits par defaut sinon (admin complet pour moderation complete)
    34 // http://doc.spip.org/@autoriser_modererforum_dist
     58/**
     59 * Autorisation de modérer un message de forum
     60 *
     61 * Il faut l'autorisation de modifier l'objet correspondant
     62 * (si le forum est attaché à un objet), sinon avoir droits par défaut
     63 * (être administrateur).
     64 *
     65 * @see autoriser_forum_moderer_dist()
     66 *
     67 * @param  string $faire Action demandée
     68 * @param  string $type  Type d'objet sur lequel appliquer l'action
     69 * @param  int    $id    Identifiant de l'objet
     70 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     71 * @param  array  $opt   Options de cette autorisation
     72 * @return bool          true s'il a le droit, false sinon
     73**/
    3574function autoriser_modererforum_dist($faire, $type, $id, $qui, $opt) {
    3675        return $type ? autoriser('modifier', $type, $id, $qui, $opt):autoriser('moderer', 'forum', 0, $qui, $opt);
     
    3877
    3978/**
    40  * Autorise a changer le statut d'un message de forum :
    41  * seulement sur les objets qu'on a le droit de moderer
     79 * Autorisation de changer le statut d'un message de forum
     80 *
     81 * Seulement sur les objets qu'on a le droit de modérer.
     82 *
     83 * @param  string $faire Action demandée
     84 * @param  string $type  Type d'objet sur lequel appliquer l'action
     85 * @param  int    $id    Identifiant de l'objet
     86 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     87 * @param  array  $opt   Options de cette autorisation
     88 * @return bool          true s'il a le droit, false sinon
    4289 */
    4390function autoriser_forum_instituer_dist($faire, $type, $id, $qui, $opt){
     
    4794}
    4895
     96/**
     97 * Autorisation par défaut de modérer un message de forum
     98 *
     99 * Si l'on connait l'objet, on délègue à modererforum, sinon il faut
     100 * être administrateur
     101 *
     102 * @see autoriser_modererforum_dist()
     103 *
     104 * @param  string $faire Action demandée
     105 * @param  string $type  Type d'objet sur lequel appliquer l'action
     106 * @param  int    $id    Identifiant de l'objet
     107 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     108 * @param  array  $opt   Options de cette autorisation
     109 * @return bool          true s'il a le droit, false sinon
     110 */
    49111function autoriser_forum_moderer_dist($faire, $type, $id, $qui, $opt){
    50112        // si on fournit un id : deleguer a modererforum sur l'objet concerne
     
    62124}
    63125
    64 // Modifier un forum ?
    65 // = jamais !
    66 // http://doc.spip.org/@autoriser_forum_modifier_dist
     126
     127/**
     128 * Autorisation de modifier un message de forum
     129 *
     130 * Jamais
     131 *
     132 * @param  string $faire Action demandée
     133 * @param  string $type  Type d'objet sur lequel appliquer l'action
     134 * @param  int    $id    Identifiant de l'objet
     135 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     136 * @param  array  $opt   Options de cette autorisation
     137 * @return bool          true s'il a le droit, false sinon
     138 */
    67139function autoriser_forum_modifier_dist($faire, $type, $id, $qui, $opt) {
    68140        return false;
    69141}
    70142
    71 // Consulter le forum des admins ?
    72 // admins y compris restreints
    73 // http://doc.spip.org/@autoriser_forum_admin_dist
     143/**
     144 * Autorisation de consulter le forum des administrateurs
     145 *
     146 * Il faut être administrateur (y compris restreint)
     147 *
     148 * @param  string $faire Action demandée
     149 * @param  string $type  Type d'objet sur lequel appliquer l'action
     150 * @param  int    $id    Identifiant de l'objet
     151 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     152 * @param  array  $opt   Options de cette autorisation
     153 * @return bool          true s'il a le droit, false sinon
     154 */
    74155function autoriser_forum_admin_dist($faire, $type, $id, $qui, $opt) {
    75156        return $qui['statut'] == '0minirezo';
     
    77158
    78159/**
    79  * Auto-association de documents sur des forum : niet
     160 * Autorisation d'auto-association de documents sur des forum
     161 *
     162 * Jamais
     163 *
     164 * @param  string $faire Action demandée
     165 * @param  string $type  Type d'objet sur lequel appliquer l'action
     166 * @param  int    $id    Identifiant de l'objet
     167 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     168 * @param  array  $opt   Options de cette autorisation
     169 * @return bool          true s'il a le droit, false sinon
    80170 */
    81 function autoriser_forum_autoassocierdocument_dist($faire, $type, $id, $qui, $opts) {
     171function autoriser_forum_autoassocierdocument_dist($faire, $type, $id, $qui, $opt) {
    82172        return false;
    83173}
    84174
    85175/**
    86  * Autoriser a participer au forum des admins
     176 * Autorisation de participer au forum des admins
    87177 *
    88  * @return bool
     178 * Il faut être administrateur (y compris restreint)
     179 *
     180 * @param  string $faire Action demandée
     181 * @param  string $type  Type d'objet sur lequel appliquer l'action
     182 * @param  int    $id    Identifiant de l'objet
     183 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     184 * @param  array  $opt   Options de cette autorisation
     185 * @return bool          true s'il a le droit, false sinon
    89186 */
    90 function autoriser_forumadmin_participer_dist($faire, $type, $id, $qui, $opts) {
     187function autoriser_forumadmin_participer_dist($faire, $type, $id, $qui, $opt) {
    91188        return ($GLOBALS['meta']['forum_prive_admin'] == 'oui') && $qui['statut']=='0minirezo';
    92189}
  • _core_/plugins/forum/forum_fonctions.php

    r69328 r69933  
    1111\***************************************************************************/
    1212
     13/**
     14 * Définit les fonctions utiles du plugin forum
     15 *
     16 * @package SPIP\Forum\Fonctions
     17**/
     18
    1319if (!defined("_ECRIRE_INC_VERSION")) return;
    1420
     
    1723
    1824/**
    19  * Un filtre applique a #PARAMETRES_FORUM, qui donne l'adresse de la page
    20  * de reponse
     25 * Un filtre appliqué à `#PARAMETRES_FORUM`, qui donne l'adresse de la page
     26 * de réponse
    2127 *
    22  * @param $parametres
    23  * @return string
     28 * @example
     29 *     ```
     30 *     [<p class="repondre">
     31 *          <a href="(#PARAMETRES_FORUM|url_reponse_forum)">
     32 *          <:repondre_article:>
     33 *          </a>
     34 *      </p>]
     35 *      ```
     36 *
     37 * @filtre url_rss_forum
     38 * @see balise_PARAMETRES_FORUM_dist()
     39 *
     40 * @param string $parametres
     41 * @return string URL de la page de réponse
    2442 */
    2543function filtre_url_reponse_forum($parametres) {
     
    2947
    3048/**
    31  * Un filtre qui, etant donne un #PARAMETRES_FORUM, retourne un URL de suivi rss
     49 * Un filtre qui, étant donné un `#PARAMETRES_FORUM`, retourne une URL de suivi rss
    3250 * dudit forum
    33  * Attention applique a un #PARAMETRES_FORUM complexe (id_article=x&id_forum=y)
    34  * ca retourne un url de suivi du thread y (que le thread existe ou non)
     51 *
     52 * Attention : appliqué à un `#PARAMETRES_FORUM` complexe (`id_article=x&id_forum=y`)
     53 * ça retourne une URL de suivi du thread `y` (que le thread existe ou non)
    3554 *
    36  * @param $param
    37  * @return string
     55 * @filtre url_rss_forum
     56 * @see balise_PARAMETRES_FORUM_dist()
     57 *
     58 * @param string $param
     59 * @return string URL pour le suivi RSS
    3860 */
    3961function filtre_url_rss_forum($param) {
     
    4466}
    4567
     68/**
     69 * Empêche l'exécution de code HTML
     70 *
     71 * Permet si la constante `_INTERDIRE_TEXTE_HTML`  est définie
     72 * (ce n'est pas le cas par défaut) d'échapper les balises HTML
     73 * d'un texte (de sorte qu'elles seront affichées et non traitées par
     74 * le navigateur).
     75 *
     76 * @see forum_declarer_tables_interfaces()
     77 *
     78 * @param string $texte
     79 * @return string
     80**/
    4681function interdit_html($texte){
    4782        if (defined('_INTERDIRE_TEXTE_HTML'))
  • _core_/plugins/forum/forum_ieconfig.php

    r57797 r69933  
    11<?php
     2
     3/**
     4 * Déclarations des configurations qui peuvent être sauvegardées
     5 *
     6 * @package SPIP\Forum\Pipelines
     7**/
    28
    39if (!defined("_ECRIRE_INC_VERSION")) return;
    410
    5 // On déclare ici la config du core
     11/**
     12 * Ajoute les metas sauvegardables de Forum 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**/
    621function forum_ieconfig_metas($table){
    722        $table['forums_contenu']['titre'] = _T('forum:titre_forum');
Note: See TracChangeset for help on using the changeset viewer.