Changeset 70182 in spip-zone


Ignore:
Timestamp:
Feb 25, 2013, 8:31:50 AM (8 years ago)
Author:
kent1@…
Message:

Un peu de doc

Location:
_plugins_/diogene/diogene/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/diogene/diogene/trunk/diogene_fonctions.php

    r69821 r70182  
    99 *
    1010 * Fonctions spécifiques à Diogene
    11  *
     11 *
     12 * @package SPIP\Diogene\Fonctions
    1213 **/
    1314
     
    2122 * Pratique pour les liens vers associé à une auteur mais pas encore publiés
    2223 *
    23  * @param unknown_type $p
     24 * @param Champ $p
     25 *              Pile au niveau de la balise
     26 * @return Champ
     27 *     Pile complétée du code compilé
    2428 */
    2529function balise_URL_ARTICLE($p) {
     
    4650 * Utilisé que sur les objets à base d'articles
    4751 *
    48  * @param int $id_diogene : l'identifiant numérique du diogene
    49  * @return string|int|false : le retour à trois types de valeurs :
    50  *              string "infinite" : le nombre est infini
    51  *              boolean false : il y a une erreur, pas de limite pour ce genre d'objet
    52  *              int : le nombre possible
     52 * @param int
     53 *              $id_diogene : l'identifiant numérique du diogene
     54 * @return string|int|false
     55 *              le retour à trois types de valeurs :
     56 *              - string "infinite" : le nombre est infini
     57 *              - boolean false : il y a une erreur, pas de limite pour ce genre d'objet
     58 *              - int : le nombre possible
    5359 */
    5460function diogene_nombre_attente($id_diogene){
     
    7783 * Génération d'une url vers la page de publication d'un objet
    7884 *
    79  * @param int $id Identifiant numérique de l'objet
    80  * @param string $objet Le type de l'objet
    81  * @param boolean $forcer Dans le cas où l'objet est déjà publié cela renverra vers la page de l'objet. Si $forcer = true,
    82  * cela forcera le fait d'aller sur la page de modification de l'objet
    83  * @return string $url L'URL de la page que l'on souhaite
     85 * @param int $id
     86 *              Identifiant numérique de l'objet
     87 * @param string
     88 *              $objet Le type de l'objet
     89 * @param boolean
     90 *              $forcer Dans le cas où l'objet est déjà publié cela renverra vers la page de l'objet. Si $forcer = true,
     91 *              cela forcera le fait d'aller sur la page de modification de l'objet
     92 * @return string $url
     93 *              L'URL de la page que l'on souhaite
    8494 */
    8595function generer_url_publier($id=null,$objet='article',$id_secteur=0,$forcer=true){
     
    132142 * Fonction retournant la chaine de langue depuis un statut
    133143 *
    134  * @param string $statut Le statut de l'objet
    135  * @param string $type Le type d'objet SPIP
    136  * @return string La locution adéquate pour le statut
     144 * @param string $statut
     145 *              Le statut de l'objet
     146 * @param string $type
     147 *              Le type d'objet SPIP
     148 * @return string
     149 *              La locution adéquate pour le statut
    137150 */
    138151function diogene_info_statut($statut, $type='article') {
     
    170183}
    171184
     185/**
     186 * Être sûr d'avoir les fonctions des puces
     187 */
    172188if(!function_exists('puce_statut')){
    173189        include_spip('inc/autoriser');
     
    224240 * @param string $aide
    225241 *              cle d'identification de l'aide souhaitee
    226  * @param strink $skel
     242 * @param string $skel
    227243 *              Nom du squelette qui appelle ce bouton d'aide
    228244 * @param array $env
  • _plugins_/diogene/diogene/trunk/diogene_options.php

    r69570 r70182  
    66 * kent1 (http://www.kent1.info - kent1@arscenic.info)
    77 *
    8  * © 2010-2012 - Distribue sous licence GNU/GPL
     8 * © 2010-2013 - Distribue sous licence GNU/GPL
    99 *
    1010 * Options spécifiques à Diogene
    11  *
     11 *
     12 * @package SPIP\Diogene\Options
    1213 **/
    1314
    1415if (!defined("_ECRIRE_INC_VERSION")) return;
    1516
     17/**
     18 * On désactive les puce rapide dans le public
     19 * Demande trop de css et autres trucs pour être sûr que ce soit correct partout
     20 */
    1621if(!test_espace_prive() && !defined(_ACTIVER_PUCE_RAPIDE)){
    1722        define(_ACTIVER_PUCE_RAPIDE,false);
  • _plugins_/diogene/diogene/trunk/diogene_pipelines.php

    r69857 r70182  
    66 * kent1 (http://www.kent1.info - kent1@arscenic.info)
    77 *
    8  * © 2010-2012 - Distribue sous licence GNU/GPL
     8 * © 2010-2013 - Distribue sous licence GNU/GPL
    99 *
    1010 * Utilisation des pipelines par Diogene
    1111 *
     12 * @package SPIP\Diogenes\Pipelines
    1213 **/
    1314
     
    1617/**
    1718 * Insertion dans le pipeline editer_contenu_objet (SPIP)
     19 *
    1820 * Insère ou enlève les champs dans le formulaire
    1921 * que l'on souhaite ajouter ou supprimer
    2022 *
    2123 * @param array $flux
    22  * @return array
     24 *              Le contexte du pipeline
     25 * @return array $flux
     26 *              Le contexte du pipeline modifié
    2327 */
    2428function diogene_editer_contenu_objet($flux){
    25         $args = $flux['args'];
    2629        $type = $args['type'];
    27         $langues_dispos = explode(',',$GLOBALS['meta']['langues_multilingue']);
    2830        $pipeline = pipeline('diogene_objets', array());
    2931
    3032        if (in_array($type,array_keys($pipeline))){
     33                $args = $flux['args'];
     34                $langues_dispos = explode(',',$GLOBALS['meta']['langues_multilingue']);
     35               
     36                /**
     37                 * Recherche de l'id_secteur afin de trouver le bon diogène
     38                 * - soit on a un id_secteur > 0 dans le contexte;
     39                 * - soit on a un id_parent dans le contexte et on cherche son secteur
     40                 */
    3141                $id_secteur = ($args['contexte']['id_secteur'] > 0) ?
    3242                        $args['contexte']['id_secteur'] :
     
    3545                /**
    3646                 * Cas des pages uniques
     47                 *
     48                 * On n'a pas d'id_secteur et on a un id_parent dans le contexte soit = 0 soit = -1
     49                 * Du coup c'est le cas d'une page unique, on change donc le type en "page", id_secteur en "0"
    3750                 */
    3851                if(!$id_secteur && (($args['contexte']['id_parent'] == 0) OR ($args['contexte']['id_parent'] == '-1') OR (!$args['contexte']['id_parent']  && !$args['contexte']['parents'])) && ($type=='article')){
     
    4053                        $type = 'page';
    4154                }
     55               
     56                /**
     57                 * Création de la clause Where de la requète pour trouver dans quel diogène on est
     58                 */
    4259                if($type == 'article'){
    4360                        if($id_diogene = intval(_request('id_diogene'))){
     
    5673                }
    5774
     75                /**
     76                 * On n'agit que si on a trouvé un diogene
     77                 */
    5878                if($diogene = sql_fetsel('*','spip_diogenes',$where)){
    5979                        /**
     
    167187                                 * Uniquement si l'on n'est pas dans le privé
    168188                                 */
    169                                 if($type=='page'){
     189                                if($type=='page')
    170190                                        $type='article';
    171                                 }
    172 
     191
     192                                spip_log($args['contexte']['statut'],'test');
    173193                                if(!test_espace_prive() && find_in_path('formulaires/selecteur_statut_'.$diogene['objet'].'.html')){
    174194                                        $saisie .= recuperer_fond('formulaires/selecteur_statut_'.$diogene['objet'],$args['contexte']);
     
    195215 * ainsi que l'id_diogene dans les hidden.
    196216 *
    197  * @param array $flux Le contexte d'environnement du pipeline
    198  * @return array $flux Le contexte d'environnement modifié
     217 * @param array $flux
     218 *              Le contexte d'environnement du pipeline
     219 * @return array $flux
     220 *              Le contexte d'environnement modifié
    199221 */
    200222function diogene_formulaire_charger($flux){
     
    299321 * Les sous plugins peuvent se brancher sur le pipeline spécifique à Diogene : diogene_verifier
    300322 *
    301  * @param array $flux Le contexte d'environnement du pipeline
    302  * @return array $flux Le contexte d'environnement modifié
     323 * @param array $flux
     324 *              Le contexte d'environnement du pipeline
     325 * @return array $flux
     326 *              Le contexte d'environnement modifié
    303327 */
    304328function diogene_formulaire_verifier($flux){
     
    350374 * -* On ajoute un ajaxReload dans le message de retour pour rafraichir certains morceaux de la page (jQuery(".description_$objet,.diogene_$id_diogene"))
    351375 *
    352  * @param array $flux Le contexte d'environnement du pipeline
    353  * @return array $flux Le contexte d'environnement modifié
     376 * @param array $flux
     377 *              Le contexte d'environnement du pipeline
     378 * @return array $flux
     379 *              Le contexte d'environnement modifié
    354380 */
    355381function diogene_formulaire_traiter($flux){
     
    413439 * Insertion dans le pipeline pre_insertion (SPIP)
    414440 *
    415  * A la creation d'un article on vérifie si on nous envoie la langue
     441 * A la création d'un article on vérifie si on nous envoie la langue
    416442 * si oui on la met correctement dès l'insertion
    417443 *
    418  * @param array $flux le contexte du pipeline
    419  * @return array $flux le contexte modifié
     444 * @param array $flux
     445 *              Le contexte du pipeline
     446 * @return array $flux
     447 *              Le contexte modifié
    420448 */
    421449function diogene_pre_insertion($flux){
     
    433461 * si elle est différente de celle de l'article on la change
    434462 *
    435  * @param array $flux le contexte du pipeline
    436  * @return array $flux le contexte modifié
     463 * @param array $flux
     464 *              Le contexte du pipeline
     465 * @return array $flux
     466 *              Le contexte modifié
    437467 */
    438468function diogene_pre_edition($flux){
     
    486516 * Notamment pour lancer un recalcul de la publication des rubriques
    487517 *
    488  * @param array $flux le contexte du pipeline
    489  * @return array $flux le contexte modifié
     518 * @param array $flux
     519 *              Le contexte du pipeline
     520 * @return array $flux
     521 *              Le contexte modifié
    490522 */
    491523function diogene_post_edition($flux){
     
    509541 * On ajoute les champs que l'on peut ajouter
    510542 *
    511  * @param array $flux Un tableau bidimentionnel listant les champs pouvant être ajoutés aux objets
    512  * @retrun array $flux Le tableau modifié
     543 * @param array $flux
     544 *              Un tableau bidimentionnel listant les champs pouvant être ajoutés aux objets
     545 * @return array $flux
     546 *              Le tableau modifié
    513547 */
    514548function diogene_diogene_objets($flux){
     
    538572 * -* formulaires/dateur/inc-dateur.html si une date est présente dans le formulaire
    539573 *
    540  * @param array $flux le contexte du pipeline
    541  * @return array $flux le contexte modifié
     574 * @param array $flux
     575 *              Le contexte du pipeline
     576 * @return array $flux
     577 *              Le contexte modifié
    542578 */
    543579function diogene_diogene_avant_formulaire($flux){
     
    555591 * Insert les saisies configurées dans le formulaire
    556592 *
    557  * @param array $flux le contexte du pipeline
    558  * @return array $flux le contexte modifié
     593 * @param array $flux
     594 *              Le contexte du pipeline
     595 * @return array $flux
     596 *              Le contexte modifié
    559597 */
    560598function diogene_diogene_ajouter_saisies($flux){
     
    605643 * -* vérifie la valeur pour le forum également
    606644 *
    607  * @param array $flux le contexte du pipeline
    608  * @return array $flux le contexte modifié
     645 * @param array $flux
     646 *              Le contexte du pipeline
     647 * @return array $flux
     648 *              Le contexte modifié
    609649 */
    610650function diogene_diogene_verifier($flux){
     
    637677 * -* traite la valeur pour le forum également
    638678 *
    639  * @param array $flux le contexte du pipeline
    640  * @return array $flux le contexte modifié
     679 * @param array $flux
     680 *              Le contexte du pipeline
     681 * @return array $flux
     682 *              Le contexte modifié
    641683 */
    642684function diogene_diogene_traiter($flux){
     
    661703
    662704/**
    663  * Insertion dans le pipeline (ajouter_menus)
     705 * Insertion dans le pipeline ajouter_menus (SPIP)
    664706 *
    665707 * Ajouter des boutons dans les menus pour chaque diogène que l'on sait gérer dans l'espace privé
    666708 *
    667  * @param object $boutons_admin La description des boutons
    668  * @return object $boutons_admin La description des boutons complétée
     709 * @param object $boutons_admin
     710 *              La description des boutons
     711 * @return object $boutons_admin
     712 *              La description des boutons complétée
    669713 */
    670714function diogene_ajouter_menus($boutons_admin) {
Note: See TracChangeset for help on using the changeset viewer.