Changeset 65040 in spip-zone


Ignore:
Timestamp:
Aug 20, 2012, 1:16:27 PM (9 years ago)
Author:
marcimat@…
Message:

PHPDoc complet des brèves

Location:
_core_/plugins/breves
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/breves/action/editer_breve.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion de l'action editer_breve
     15 *
     16 * @package SPIP\Breve\Actions
     17 */
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
    15 // http://doc.spip.org/@action_editer_breve_dist
     20/**
     21 * Action d'édition d'une brève dans la base de données dont
     22 * l'identifiant est donné en paramètre de cette fonction ou
     23 * en argument de l'action sécurisée
     24 *
     25 * Si aucun identifiant n'est donné, on crée alors une nouvelle brève.
     26 *
     27 * @param null|int $arg
     28 *     Identifiant de la brève. En absence utilise l'argument
     29 *     de l'action sécurisée.
     30 * @return array
     31 *     Liste : identifiant de la brève, texte d'erreur éventuel
     32**/
    1633function action_editer_breve_dist($arg=null) {
    1734
     
    3451}
    3552
    36 /**
    37  * Inserer une breve en base
    38  * http://doc.spip.org/@insert_breve
    39  *
     53
     54/**
     55 * Insertion d'une brève dans une rubrique
     56 *
     57 * @pipeline_appel pre_insertion
     58 * @pipeline_appel post_insertion
     59 *
    4060 * @param int $id_rubrique
     61 *     Identifiant de la rubrique
    4162 * @return int
     63 *     Identifiant de la nouvelle brève.
    4264 */
    4365function breve_inserer($id_rubrique) {
     
    86108
    87109
    88 /**
    89  * Modifier une breve en base
    90  * $c est un contenu (par defaut on prend le contenu via _request())
    91  *
    92  * http://doc.spip.org/@revisions_breves
    93  *
     110
     111/**
     112 * Modifier une brève en base
     113 *
    94114 * @param int $id_breve
    95  * @param array $set
    96  * @return string|bool
     115 *     Identifiant de la brève à modifier
     116 * @param array|null $set
     117 *     Couples (colonne => valeur) de données à modifier.
     118 *     En leur absence, on cherche les données dans les champs éditables
     119 *     qui ont été postés (via _request())
     120 * @return string|null
     121 *     Chaîne vide si aucune erreur,
     122 *     Null si aucun champ à modifier,
     123 *     Chaîne contenant un texte d'erreur sinon.
    97124 */
    98125function breve_modifier ($id_breve, $set=null) {
     
    129156}
    130157
    131 /**
    132  * Instituer une breve : modifier son statut ou son parent
    133  *
     158
     159/**
     160 * Instituer une brève : modifier son statut ou son parent
     161 *
     162 * @pipeline_appel pre_insertion
     163 * @pipeline_appel post_insertion
     164 *
    134165 * @param int $id_breve
     166 *     Identifiant de la brève
    135167 * @param array $c
    136  * @return string
     168 *     Couples (colonne => valeur) des données à instituer
     169 * @return string|null
     170 *     Null si aucun champ à modifier, chaîne vide sinon.
    137171 */
    138172function breve_instituer($id_breve, $c) {
     
    227261}
    228262
     263
     264// Fonctions Dépréciées
     265// --------------------
     266
     267/**
     268 * Insertion d'une brève dans une rubrique
     269 *
     270 * @deprecated Utiliser breve_inserer()
     271 * @see breve_inserer()
     272 *
     273 * @param int $id_rubrique
     274 *     Identifiant de la rubrique
     275 * @return int
     276 *     Identifiant de la nouvelle brève.
     277 */
    229278function insert_breve($id_rubrique) {
    230279        return breve_inserer($id_rubrique);
    231280}
     281
     282/**
     283 * Créer une révision de brève
     284 *
     285 * @deprecated Utiliser breve_modifier()
     286 * @see breve_modifier()
     287 *
     288 * @param int $id_breve
     289 *     Identifiant de la brève à modifier
     290 * @param array|null $set
     291 *     Couples (colonne => valeur) de données à modifier.
     292 *     En leur absence, on cherche les données dans les champs éditables
     293 *     qui ont été postés (via _request())
     294 * @return string|null
     295 *     Chaîne vide si aucune erreur,
     296 *     Null si aucun champ à modifier,
     297 *     Chaîne contenant un texte d'erreur sinon.
     298 */
    232299function revisions_breves ($id_breve, $set=false) {
    233300        return breve_modifier($id_breve,$set);
  • _core_/plugins/breves/base/breves.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Déclarations relatives à la base de données
     15 *
     16 * @package SPIP\Breves\Pipelines
     17**/
     18
    1319if (!defined('_ECRIRE_INC_VERSION')) return;
    1420
    1521/**
    16  * Interfaces des tables breves pour le compilateur
     22 * Déclare les alias de boucle et traitements automatiques de certaines balises
    1723 *
     24 * @pipeline declarer_tables_interfaces
    1825 * @param array $interfaces
     26 *     Déclarations d'interface pour le compilateur
    1927 * @return array
     28 *     Déclarations d'interface pour le compilateur
    2029 */
    2130function breves_declarer_tables_interfaces($interfaces) {
     
    3342}
    3443
    35 
     44/**
     45 * Déclarer l'objet éditorial de brèves
     46 *
     47 * @pipeline declarer_tables_objets_sql
     48 * @param array $tables
     49 *     Description des tables
     50 * @return array
     51 *     Description complétée des tables
     52 */
    3653function breves_declarer_tables_objets_sql($tables){
    3754        $tables['spip_breves'] = array(
  • _core_/plugins/breves/breves_administrations.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Fichier gérant l'installation et désinstallation du plugin
     15 *
     16 * @package SPIP\Breves\Installation
     17**/
    1318if (!defined('_ECRIRE_INC_VERSION')) return;
    1419
    1520/**
    16  * Installation/maj des tables breves
     21 * Installation/maj des tables de brèves
    1722 *
     23 * Crée les tables SQL du plugin (spip_breves)
     24 *
    1825 * @param string $nom_meta_base_version
     26 *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
    1927 * @param string $version_cible
     28 *     Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
    2029 */
    2130function breves_upgrade($nom_meta_base_version,$version_cible){
     
    4251}
    4352
     53
    4454/**
    45  * Desinstallation/suppression des tables breves
     55 * Désinstallation du plugin
    4656 *
     57 * Supprime les tables SQL du plugin (spip_breves)
     58 *
    4759 * @param string $nom_meta_base_version
    48  */
     60 *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
     61**/
    4962function breves_vider_tables($nom_meta_base_version) {
    5063        sql_drop_table("spip_breves");
  • _core_/plugins/breves/breves_autoriser.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Déclarations d'autorisations
     15 *
     16 * @package SPIP\Breves\Autorisations
     17**/
    1318if (!defined('_ECRIRE_INC_VERSION')) return;
    1419
    15 // pour le pipeline d'autorisation
     20/**
     21 * Fonction du pipeline autoriser. N'a rien à faire
     22 * @pipeline autoriser
     23 */
    1624function breves_autoriser(){}
    1725
    1826
    19 // bouton du bandeau
     27/**
     28 * Autoriser les brèves dans le menu de navigation
     29 *
     30 * @param  string $faire Action demandée
     31 * @param  string $type  Type d'objet sur lequel appliquer l'action
     32 * @param  int    $id    Identifiant de l'objet
     33 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     34 * @param  array  $opt   Options de cette autorisation
     35 * @return bool          true s'il a le droit, false sinon
     36 */
    2037function autoriser_breves_menu_dist($faire, $type='', $id=0, $qui = NULL, $opt = NULL){
    2138        return  ($GLOBALS['meta']["activer_breves"] != "non");
    2239}
     40
     41/**
     42 * Autoriser la création de brèves dans le menu de navigation
     43 *
     44 * @param  string $faire Action demandée
     45 * @param  string $type  Type d'objet sur lequel appliquer l'action
     46 * @param  int    $id    Identifiant de l'objet
     47 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     48 * @param  array  $opt   Options de cette autorisation
     49 * @return bool          true s'il a le droit, false sinon
     50 */
    2351function autoriser_brevecreer_menu_dist($faire, $type, $id, $qui, $opt){
    2452        return  ($GLOBALS['meta']["activer_breves"] != "non");
     
    2654
    2755
    28 
    29 // Autoriser a creer une breve dans la rubrique $id
    30 // http://doc.spip.org/@autoriser_rubrique_creerbrevedans_dist
     56/**
     57 * Autoriser à créer une brève dans la rubrique $id
     58 *
     59 * @param  string $faire Action demandée
     60 * @param  string $type  Type d'objet sur lequel appliquer l'action
     61 * @param  int    $id    Identifiant de l'objet
     62 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     63 * @param  array  $opt   Options de cette autorisation
     64 * @return bool          true s'il a le droit, false sinon
     65 */
    3166function autoriser_rubrique_creerbrevedans_dist($faire, $type, $id, $qui, $opt) {
    3267        $r = sql_fetsel("id_parent", "spip_rubriques", "id_rubrique=".intval($id));
     
    3974
    4075
    41 // Autoriser a modifier la breve $id
    42 // = admins & redac si la breve n'est pas publiee
    43 // = admins de rubrique parente si publiee
    44 // http://doc.spip.org/@autoriser_breve_modifier_dist
     76/**
     77 * Autoriser à modifier la brève $id
     78 *
     79 * - admins & redac si la brève n'est pas publiée
     80 * - admins de rubrique parente si publiée
     81 *
     82 * @param  string $faire Action demandée
     83 * @param  string $type  Type d'objet sur lequel appliquer l'action
     84 * @param  int    $id    Identifiant de l'objet
     85 * @param  array  $qui   Description de l'auteur demandant l'autorisation
     86 * @param  array  $opt   Options de cette autorisation
     87 * @return bool          true s'il a le droit, false sinon
     88 */
    4589function autoriser_breve_modifier_dist($faire, $type, $id, $qui, $opt) {
    4690        $r = sql_fetsel("id_rubrique,statut", "spip_breves", "id_breve=".intval($id));
  • _core_/plugins/breves/breves_ieconfig.php

    r57793 r65040  
    11<?php
     2
     3/**
     4 * Déclarations des configurations qui peuvent être sauvegardées
     5 *
     6 * @package SPIP\Breves\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 Brèves 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 breves_ieconfig_metas($table){
    722        $table['breves']['titre'] = _T('breves:titre_breves');
  • _core_/plugins/breves/breves_pipelines.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Utilisations de pipelines
     15 *
     16 * @package SPIP\Breves\Pipelines
     17**/
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
    1520
    1621/**
    17  * Definir les meta de configuration liee aux breves
     22 * Définir les meta de configuration liées aux brèves
    1823 *
    1924 * @param array $metas
     25 *     Couples nom de la méta => valeur par défaut
    2026 * @return array
     27 *    Couples nom de la méta => valeur par défaut
    2128 */
    2229function breves_configurer_liste_metas($metas){
     
    2633
    2734/**
    28  * Ajouter les breves a valider sur les rubriques
    29  *
    30  * @param array $flux
    31  * @return array
     35 * Ajouter les brèves à valider sur les rubriques
     36 *
     37 * @pipeline rubrique_encours
     38 *
     39 * @param array $flux  Données du pipeline
     40 * @return array       Données du pipeline
    3241**/
    3342function breves_rubrique_encours($flux){
     
    5362
    5463/**
    55  * Ajouter les breves references sur les vues de rubriques
    56  *
    57  * @param array $flux
    58  * @return array
     64 * Ajouter les brèves référencées sur les vues de rubriques
     65 *
     66 * @pipeline affiche_enfants
     67 *
     68 * @param array $flux  Données du pipeline
     69 * @return array       Données du pipeline
    5970**/
    6071function breves_affiche_enfants($flux) {
     
    8495
    8596/**
    86  * Bloc sur les informations generales concernant chaque type d'objet
    87  *
     97 * Ajoute le nombre de brèves sur l'accueil privé
     98 *
     99 * @pipeline accueil_informations
     100 *
    88101 * @param string $texte
     102 *     HTML des informations générales concernant chaque type d'objet
     103 *     sur la page d'accueil privée
    89104 * @return string
     105 *     HTML des informations générales concernant chaque type d'objet
     106 *     sur la page d'accueil privée
    90107 */
    91108function breves_accueil_informations($texte){
     
    130147
    131148/**
    132  * Compter les breves dans une rubrique
    133  *
    134  * @param array $flux
    135  * @return array
     149 * Compter les brèves dans une rubrique
     150 *
     151 * @pipeline objet_compte_enfants
     152 *
     153 * @param array $flux  Données du pipeline
     154 * @return array       Données du pipeline
    136155 */
    137156function breves_objet_compte_enfants($flux){
     
    150169
    151170/**
    152  * Changer la langue des breves si la rubrique change
    153  *
    154  * @param array $flux
    155  * @return array
     171 * Changer la langue des brèves si la rubrique change
     172 *
     173 * @pipeline trig_calculer_langues_rubriques
     174 *
     175 * @param array $flux  Données du pipeline
     176 * @return array       Données du pipeline
    156177 */
    157178function breves_trig_calculer_langues_rubriques($flux){
     
    162183                sql_updateq('spip_breves', array("lang"=>$row['lang'], 'langue_choisie'=>'non'), "id_breve=$id_breve");
    163184        }
    164                
    165         return $flux;
    166 }
    167 
    168 
    169 /**
    170  * Publier et dater les rubriques qui ont une breve publie
    171  *
    172  * @param array $flux
    173  * @return array
     185
     186        return $flux;
     187}
     188
     189
     190/**
     191 * Publier et dater les rubriques qui ont une brève publiée
     192 *
     193 * @pipeline calculer_rubriques
     194 *
     195 * @param array $flux  Données du pipeline
     196 * @return array       Données du pipeline
    174197 */
    175198function breves_calculer_rubriques($flux){
     
    184207
    185208
    186 
    187 /**
    188  * Ajouter les breves a valider sur la page d'accueil
    189  *
    190  * @param array $flux
    191  * @return array
     209/**
     210 * Ajouter les brèves à valider sur la page d'accueil
     211 *
     212 * @pipeline accueil_encours
     213 *
     214 * @param string $flux  HTML du bloc encours sur la page d'accueil privée
     215 * @return string       HTML du bloc encours sur la page d'accueil privée
    192216**/
    193217function breves_accueil_encours($flux){
     
    206230
    207231/**
    208  * Optimiser la base de donnee en supprimant les liens orphelins
    209  *
    210  * @param array $flux
    211  * @return array
     232 * Optimiser la base de données en supprimant les liens de brèves orphelins
     233 *
     234 * @pipeline optimiser_base_disparus
     235 *
     236 * @param array $flux  Données du pipeline
     237 * @return array       Données du pipeline
    212238 */
    213239function breves_optimiser_base_disparus($flux){
     
    238264
    239265/**
    240  * Afficher le nombre de breves dans chaque rubrique
    241  *
    242  * @param array $flux
    243  * @return array
     266 * Afficher le nombre de brèves dans chaque rubrique
     267 *
     268 * @pipeline boite_infos
     269 *
     270 * @param array $flux  Données du pipeline
     271 * @return array       Données du pipeline
    244272 */
    245273function breves_boite_infos($flux){
     
    256284
    257285/**
    258  * Configuration des contenus
    259  * @param array $flux
    260  * @return array
     286 * Ajoute le formulaire de configuration des brèves sur la page de
     287 * configuration des contenus
     288 *
     289 * @pipeline affiche_milieu
     290 *
     291 * @param array $flux  Données du pipeline
     292 * @return array       Données du pipeline
    261293 */
    262294function breves_affiche_milieu($flux){
  • _core_/plugins/breves/formulaires/configurer_breves.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion du formulaire de configuration des brèves
     15 *
     16 * @package SPIP\Breves\Formulaires
     17**/
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
     20/**
     21 * Chargement du formulaire de configuration des brèves
     22 *
     23 * @return array
     24 *     Environnement du formulaire
     25**/
    1526function formulaires_configurer_breves_charger_dist(){
    1627        foreach(array(
     
    2233}
    2334
    24 
     35/**
     36 * Traitement du formulaire de configuration des brèves
     37 *
     38 * @return array
     39 *     Retours du traitement
     40**/
    2541function formulaires_configurer_breves_traiter_dist(){
    2642        $res = array('editable'=>true);
  • _core_/plugins/breves/formulaires/editer_breve.php

    r64680 r65040  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion du formulaire de d'édition d'une brève
     15 *
     16 * @package SPIP\Breves\Formulaires
     17**/
    1318if (!defined("_ECRIRE_INC_VERSION")) return;
    1419
     
    1621include_spip('inc/editer');
    1722
     23/**
     24 * Chargement du formulaire d'édition d'une brève
     25 *
     26 * @see formulaires_editer_objet_charger()
     27 *
     28 * @param int|string $id_breve
     29 *     Identifiant de la brève. 'new' pour une nouvelle brève.
     30 * @param int $id_rubrique
     31 *     Identifiant de la rubrique parente (si connue)
     32 * @param string $retour
     33 *     URL de redirection après le traitement
     34 * @param int $lier_trad
     35 *     Identifiant de la brève que l'on cherche à traduire
     36 * @param string $config_fonc
     37 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     38 * @param array $row
     39 *     Valeurs de la ligne SQL de la brève, si connue
     40 * @param string $hidden
     41 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     42 * @return array
     43 *     Environnement du formulaire
     44**/
    1845function formulaires_editer_breve_charger_dist($id_breve='new', $id_rubrique=0, $retour='', $lier_trad=0, $config_fonc='breves_edit_config', $row=array(), $hidden=''){
    1946        $valeurs = formulaires_editer_objet_charger('breve',$id_breve,$id_rubrique,$lier_trad,$retour,$config_fonc,$row,$hidden);
     
    2552}
    2653
     54
    2755/**
    28  * Identifier le formulaire en faisant abstraction des parametres qui
    29  * ne representent pas l'objet edite
    30  */
     56 * Identifier le formulaire en faisant abstraction des paramètres qui
     57 * ne representent pas l'objet édité
     58 *
     59 * @param int|string $id_breve
     60 *     Identifiant de la brève. 'new' pour une nouvelle brève.
     61 * @param int $id_rubrique
     62 *     Identifiant de la rubrique parente (si connue)
     63 * @param string $retour
     64 *     URL de redirection après le traitement
     65 * @param int $lier_trad
     66 *     Identifiant de la brève que l'on cherche à traduire
     67 * @param string $config_fonc
     68 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     69 * @param array $row
     70 *     Valeurs de la ligne SQL de la brève, si connue
     71 * @param string $hidden
     72 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     73 * @return string
     74 *     Hash du formulaire
     75**/
    3176function formulaires_editer_breve_identifier_dist($id_breve='new', $id_rubrique=0, $retour='', $lier_trad=0, $config_fonc='breves_edit_config', $row=array(), $hidden=''){
    3277        return serialize(array(intval($id_breve),$lier_trad));
     
    3479
    3580
    36 // Choix par defaut des options de presentation
     81/**
     82 * Choix par défaut des options de présentation
     83 *
     84 * @param array $row
     85 *     Valeurs de la ligne SQL d'un mot, si connu
     86 * return array
     87 *     Configuration pour le formulaire
     88 */
    3789function breves_edit_config($row)
    3890{
     
    4799}
    48100
     101/**
     102 * Vérification du formulaire d'édition d'une brève
     103 *
     104 * @see formulaires_editer_objet_verifier()
     105 *
     106 * @param int|string $id_breve
     107 *     Identifiant de la brève. 'new' pour une nouvelle brève.
     108 * @param int $id_rubrique
     109 *     Identifiant de la rubrique parente (si connue)
     110 * @param string $retour
     111 *     URL de redirection après le traitement
     112 * @param int $lier_trad
     113 *     Identifiant de la brève que l'on cherche à traduire
     114 * @param string $config_fonc
     115 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     116 * @param array $row
     117 *     Valeurs de la ligne SQL de la brève, si connue
     118 * @param string $hidden
     119 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     120 * @return array
     121 *     Tableau des erreurs
     122 */
    49123function formulaires_editer_breve_verifier_dist($id_breve='new', $id_rubrique=0, $retour='', $lier_trad=0, $config_fonc='breves_edit_config', $row=array(), $hidden=''){
    50124        // auto-renseigner le titre si il n'existe pas
     
    55129}
    56130
    57 // http://doc.spip.org/@inc_editer_article_dist
     131/**
     132 * Traitements du formulaire d'édition d'une brève
     133 *
     134 * @see formulaires_editer_objet_traiter()
     135 *
     136 * @param int|string $id_breve
     137 *     Identifiant de la brève. 'new' pour une nouvelle brève.
     138 * @param int $id_rubrique
     139 *     Identifiant de la rubrique parente (si connue)
     140 * @param string $retour
     141 *     URL de redirection après le traitement
     142 * @param int $lier_trad
     143 *     Identifiant de la brève que l'on cherche à traduire
     144 * @param string $config_fonc
     145 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     146 * @param array $row
     147 *     Valeurs de la ligne SQL de la brève, si connue
     148 * @param string $hidden
     149 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     150 * @return array
     151 *     Tableau des erreurs
     152 */
    58153function formulaires_editer_breve_traiter_dist($id_breve='new', $id_rubrique=0, $retour='', $lier_trad=0, $config_fonc='breves_edit_config', $row=array(), $hidden=''){
    59154        return formulaires_editer_objet_traiter('breve',$id_breve,$id_rubrique,$lier_trad,$retour,$config_fonc,$row,$hidden);
  • _core_/plugins/breves/paquet.xml

    r61426 r65040  
    22        prefix="breves"
    33        categorie="edition"
    4         version="1.3.3"
     4        version="1.3.4"
    55        etat="stable"
    66        compatibilite="[3.0.0;3.1.*]"
Note: See TracChangeset for help on using the changeset viewer.