Changeset 77004 in spip-zone for _plugins_/grappes


Ignore:
Timestamp:
Oct 5, 2013, 8:52:04 PM (6 years ago)
Author:
kent1@…
Message:

PHPdoc

Location:
_plugins_/grappes/trunk
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/grappes/trunk/action/dupliquer_grappe.php

    r77001 r77004  
    11<?php
    2 
    32/**
    43 * Plugin Grappes
    5  * Licence GPL (c) 2013 Matthieu Marcillaud
     4 * Licence GPL (c) Matthieu Marcillaud
    65 */
     6
    77
    88if (!defined("_ECRIRE_INC_VERSION")) return;
     
    1010include_spip('inc/filtres');
    1111
     12/**
     13 * Action de duplication d'une grappe
     14 *
     15 * Doit recevoir comme argument ($arg) l'identifiant numérique de la grappe à dupliquer
     16 */
    1217function action_dupliquer_grappe_dist()
    1318{
     
    2025}
    2126
     27/**
     28 * La duplication de la grappe
     29 *
     30 * @param int $id_grappe
     31 *      Identification numérique de la grappe à supprimer
     32 * @return int|bool
     33 *      Retourne l'identifiant numérique de la nouvelle grappe si tout s'est bien passé,
     34 *      sinon false, si la duplication n'a pu avoir lieu
     35 */
    2236function action_dupliquer_grappe_post($id_grappe)
    2337{
     
    3953                        lier_objets('grappe',$nouvelle_grappe,$objet_lie['objet'],$objet_lie['id_objet']);
    4054                }
     55                return $nouvelle_grappe;
    4156        }
     57        return false;
    4258}
    4359?>
  • _plugins_/grappes/trunk/action/editer_grappe.php

    r67048 r77004  
    11<?php
    2 
    32/**
    4  * Plugin Groupes pour Spip 2.0
    5  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
    65 */
    76
     
    3231 * Inserer une nouvelle grappe en base
    3332 *
    34  * @return bool
     33 * @return int $id_grappe
     34 *      L'identifiant numérique de la nouvelle grappe
    3535 */
    3636function grappe_inserer() {
  • _plugins_/grappes/trunk/action/lier_objets.php

    r66869 r77004  
    11<?php
    22/**
    3  * Plugin Groupes pour Spip 2.0
    4  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
    55 */
     6
    67
    78if (!defined("_ECRIRE_INC_VERSION")) return;
  • _plugins_/grappes/trunk/action/supprimer_grappe.php

    r31858 r77004  
    11<?php
    2 
    32/**
    4  * Plugin Groupes pour Spip 2.0
    5  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
    65 */
    76
    87if (!defined("_ECRIRE_INC_VERSION")) return;
    98
    10 include_spip('inc/filtres');
    11 
    12 // http://doc.spip.org/@action_instituer_groupe_mots_dist
     9/**
     10 * Action de suppression d'une grappe
     11 *
     12 * Doit recevoir comme argument (arg) "-#ID_GRAPPE" les "-" étant obligatoire
     13 */
    1314function action_supprimer_grappe_dist()
    1415{
     
    2122}
    2223
    23 // http://doc.spip.org/@action_instituer_groupe_mots_post
     24/**
     25 * Suppression d'une grappe
     26 *
     27 * @param int $id_grappe
     28 *      Identifiant de la grappe à supprimer avec un "-"
     29 * @return
     30 */
    2431function action_supprimer_grappe_post($id_grappe)
    2532{
  • _plugins_/grappes/trunk/base/grappes.php

    r66921 r77004  
    11<?php
    22/**
    3  * Plugin Groupes pour Spip 2.0
    4  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
     5 *
     6 * Fichier de déclaration de la base de donnée
     7 *
     8 * @package SPIP\Grappes\Pipelines
    59 */
    610
     
    812if (!defined("_ECRIRE_INC_VERSION")) return;
    913
     14/**
     15 * Insertion dans le pipeline declarer_tables_interfaces (SPIP)
     16 *
     17 * Déclaration des jointures spécifiques
     18 *
     19 * @param array $interface
     20 * @return array $interface
     21 */
    1022function grappes_declarer_tables_interfaces($interface){
    1123        $interface['tables_jointures']['spip_grappes'][] = 'grappes_liens';
     
    2638}
    2739
     40/**
     41 * Insertion dans le pipeline declarer_tables_objets_sql (SPIP)
     42 *
     43 * Déclaration de l'objet supplémentaire grappes
     44 *
     45 * @param array $tables
     46 *      Le tableau de définition de tous les objets
     47 * @return array $tables
     48 *      Le tableau complété avec notre objet supplémentaire
     49 */
    2850function grappes_declarer_tables_objets_sql($tables){
    2951        $tables['spip_grappes'] = array(
     
    6789}
    6890
     91/**
     92 * Insertion dans le pipeline declarer_tables_auxiliaires (SPIP)
     93 *
     94 * Déclaration de la table de liaison spip_grappes_liens
     95 *
     96 * @param array $tables_auxiliaires
     97 *      Le tableau des tables auxiliaires
     98 * @return array $tables_auxiliaires
     99 *      Le tableau des tables auxiliaires complétées
     100 */
    69101function grappes_declarer_tables_auxiliaires($tables_auxiliaires){
    70102        $spip_grappes_liens = array(
  • _plugins_/grappes/trunk/formulaires/editer_grappe.php

    r67306 r77004  
    11<?php
    2 
    32/**
    4  * Plugin Groupes pour Spip 2.0
    5  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
    65 */
    76
  • _plugins_/grappes/trunk/formulaires/lier_objets.php

    r50478 r77004  
    11<?php
    2 
    32/**
    4  * Plugin Groupes pour Spip 2.0
    5  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
    65 */
    76
  • _plugins_/grappes/trunk/grappes_administrations.php

    r66920 r77004  
    11<?php
    22/**
    3  * Plugin Groupes pour Spip 2.0
    4  * Licence GPL (c) 2008 Matthieu Marcillaud
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
     5 *
     6 * Fichier des fonctions d'installation, de mise à jour et de suppression
     7 * du plugin
     8 *
     9 * @package SPIP\Grappes\Installation
    510 */
    611
     
    1116 * Fonction d'installation, mise a jour de la base
    1217 *
    13  * @param unknown_type $nom_meta_base_version
    14  * @param unknown_type $version_cible
     18 * @param string $nom_meta_base_version
     19 *      Le nom de la meta d'installation
     20 * @param float $version_cible
     21 *      Version du shema d'installation de la base
    1522 */
    1623function grappes_upgrade($nom_meta_base_version,$version_cible){
     
    3138
    3239/**
    33  * Fonction de desinstallation
    34  *
    35  * @param unknown_type $nom_meta_base_version
     40 * Fonction de desinstallation du plugin
     41 *
     42 * Supprime les deux tables :
     43 * - spip_grappes
     44 * - spip_grappes_liens
     45 * Supprime la meta d'installation
     46 *
     47 * @param string $nom_meta_base_version
     48 *      Le nom de la meta d'installation
    3649 */
    3750function grappes_vider_tables($nom_meta_base_version) {
  • _plugins_/grappes/trunk/grappes_fonctions.php

    r66869 r77004  
    11<?php
     2/**
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
     5 *
     6 * Fichier des fonctions du plugin
     7 *
     8 * @package SPIP\Grappes\Fonctions
     9 */
    210
    311if (!defined("_ECRIRE_INC_VERSION")) return;
    412
     13/**
     14 * Fonction d'autorisation de base
     15 */
    516function autoriser_grappe(){}
    617
     18/**
     19 * Autorisation de création de grappe
     20 *
     21 * Retourne la même chose que l'action de modification
     22 *
     23 * @param string $faire
     24 *      Action, ici creer
     25 * @param string $type
     26 *      Type de l'objet, ici grappe
     27 * @param int $id
     28 *      Identifiant numérique de l'objet
     29 * @param array $qui
     30 *      La contenu de la session visiteur en cours
     31 * @param string|array $opt
     32 *      Les options
     33 * @return boolean
     34 *      true si autorisé, false sinon
     35 */
    736function autoriser_grappe_creer_dist($faire, $type, $id, $qui, $opt){
    837        return autoriser('modifier', $type, $id, $qui, $opt);
    938}
    1039
     40/**
     41 * Autorisation de modification de grappe
     42 *
     43 * On autorise les admins non restreints dans tous les cas
     44 * (création et modification de toutes les grappes), l'id_admin pour la modification
     45 * d'une grappe particulière
     46 *
     47 * @param string $faire
     48 *      Action, ici modifier (mais utilisé également pour creer)
     49 * @param string $type
     50 *      Type de l'objet, ici grappe
     51 * @param int $id
     52 *      Identifiant numérique de l'objet
     53 * @param array $qui
     54 *      La contenu de la session visiteur en cours
     55 * @param string|array $opt
     56 *      Les options
     57 * @return boolean
     58 *      true si autorisé, false sinon
     59 */
    1160function autoriser_grappe_modifier_dist($faire, $type, $id, $qui, $opt){
    1261        $id_admin = sql_getfetsel('id_admin','spip_grappes','id_grappe='.intval($id));
     
    1463}
    1564
     65/**
     66 * Autorisation d'association d'un objet à une grappe
     67 *
     68 * Vérifie la configuration de la grappe.
     69 *
     70 * Si pas de configuration spécifique, seuls les administrateurs et l'id_admin peuvent associer un objet
     71 *
     72 * @param string $faire
     73 *      Action, ici associer
     74 * @param string $type
     75 *      Type de l'objet, ici grappe
     76 * @param int $id
     77 *      Identifiant numérique de l'objet
     78 * @param array $qui
     79 *      La contenu de la session visiteur en cours
     80 * @param array $opt
     81 *      Les options, ici si cible est passée dans le tableau, on vérifie si ce type d'objet est autorisé
     82 * @return boolean
     83 *      true si autorisé, false sinon
     84 */
    1685function autoriser_grappe_associer_dist($faire, $type, $id, $qui, $opt){
    1786        $res = sql_fetsel(array('id_admin','liaisons','options'),'spip_grappes','id_grappe='.sql_quote($id));
    1887        if (!is_array($options = @unserialize($res['options'])))
    1988                $acces = array('0minirezo');
    20         else {
     89        else
    2190                $acces = is_array($options['acces'])?$options['acces']:array('0minirezo');
    22         }
     91
    2392        // tester le statut de l'auteur
    2493        if (!in_array($qui['statut'],$acces) OR ($res['id_admin'] != $qui['id_auteur']))
  • _plugins_/grappes/trunk/grappes_pipelines.php

    r66869 r77004  
    11<?php
    2 
     2/**
     3 * Plugin Grappes
     4 * Licence GPL (c) Matthieu Marcillaud
     5 *
     6 * Fichier de pipelines du plugin
     7 *
     8 * @package SPIP\Grappes\Pipelines
     9 */
     10 
    311if (!defined("_ECRIRE_INC_VERSION")) return;
    412
     
    917
    1018/**
    11  * Insertion dans les pipelines insert_head et header_prive
     19 * Insertion dans les pipelines insert_head et header_prive (SPIP
     20 * )
    1221 * Insérer les js du séleceteur générique s'ils ne sont pas déjà là
    1322 *
    1423 * @param string $flux
     24 *      Le contenu textuel de la balise #INSERT_HEAD
     25 * @return string
     26 *      Le contenu modifié
    1527 */
    1628function grappes_inserer_javascript($flux){
     
    2133
    2234/**
    23  * Insertion dans le pipeline afficher_contenu_objet
    24  * Ajouter le bloc des grappes aux pages qui peuvent êtres liées à une grappe
     35 * Insertion dans le pipeline afficher_contenu_objet (SPIP)
    2536 *
    26  * @param array $flux La liste des champs pour les diogenes
     37 * Ajouter le bloc des grappes aux pages d'objets pouvant être liés à une grappe
     38 *
     39 * @param array $flux
     40 *      Le contexte du pipeline
     41 * @return array $flux
     42 *      Le contexte du pipeline modifié
    2743 */
    2844function grappes_afficher_contenu_objet($flux){
     
    4763}
    4864
     65/**
     66 * Insertion dans le pipeline grappes_objets_lies (Plugin Grappes)
     67 *
     68 * Définis le tableau des objets pouvant être liés aux grappes, la clé est le type d'objet (au pluriel),
     69 * la valeur, le label affiché dans le formulaire d'édition de grappe
     70 *
     71 * @param array $array
     72 *      Le tableau du pipeline
     73 * @return array $array
     74 *      Le tableau complété
     75 */
    4976function grappes_grappes_objets_lies($array){
    5077        $array['articles'] = _T('grappes:item_groupes_association_articles');
Note: See TracChangeset for help on using the changeset viewer.