Fichier albums_pipelines.php

Utilisations de pipelines par le plugin Albums

Plugin

  • Albums

Copyright

  • 2014

Author

  • Tetue, Charles Razack

Licence

  • GNU/GPL

Source

Liste des fonctions

albums_affiche_gauche()

Modifier ou ajouter du contenu dans la colonne de gauche.
  • Gestion des albums sur le formulaire d'édition d'un objet lorsqu'on peut lui ajouter des albums mais que l'ajout de documents est désactivé.
array albums_affiche_gauche( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Note

  • Lors d'une première création de l'objet, celui-ci n'ayant pas encore d'identifiant tant que le formulaire d'edition n'est pas enregistré, les liaisions entre les albums liés et l'objet à créer sauvegardent un identifiant d'objet négatif de la valeur de id_auteur (l'auteur connecté). Ces liaisons seront corrigées apres validation dans albums_post_insertion() cf. plugin Médias.

Source

albums_affiche_milieu()

Ajout de contenu sur certaines pages.
  • Auteurs sur la fiche d'un album
  • Message sur la fiche d'un album si auteur pas autorisé à modifier (cf. autorisation)
array albums_affiche_milieu( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_afficher_complement_objet()

Ajout de contenu aux fiches des objets.
  • Albums liés aux objets activés dans la configuration du plugin
  • Documents liés aux albums en cas d'absence du portfolio (cf. note)
array albums_afficher_complement_objet( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Utilise

  • marquer_doublons_album()

Traversée par le pipeline

Package

Note

  • Les portfolios ne sont affichés que pour les objets qu'on a le droit d'éditer (cf. autoriser_joindredocument_dist). Mais pour les albums, les documents doivent être visibles dans tous les cas. Si nécessaire, on affiche donc les documents via notre squelette maison.

Source

albums_album_boutons_actions()

Utilisation du pipeline album_boutons_actions

Renvoie une liste des boutons d'actions des albums. Ils sont affichés dans les listes d'albums (footer), ou sur la fiche d'un album (boîte infos latérale). Cette liste est un tableau associatif, donc les plugins peuvent ajouter les leurs mais également modifier certaines entrées (voir note).

array albums_album_boutons_actions( array $flux )

Paramètres

  1. array $flux

    Données du pipeline $flux['data'] array tableau associatif des boutons $flux['args']['id_album'] int identifiant de l'album ['position'] string endroit où sont affichés les boutons : footer | boite_infos ['objet'] string type d'objet pour un album associé ['id_objet'] int identifiant de l'objet

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Note

  • $flux['data'] est un tableau associatif de la forme identifiant de l'action => code HTML du bouton. Les identifiants sont à priori des verbes : «vider», «supprimer», «giboliner», etc. Ça permet, en plus de compléter la liste, d'avoir la main sur des entrées précises.
    array( 'dissocier' => 'code HTML' 'vider' => 'code HTML' )

Source

albums_boite_infos()

Afficher le nombre d'albums liés dans la boîte infos des rubriques
array albums_boite_infos( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_compagnon_messages()

Compléter ou modifier la liste des messages des compagnons.
  • Page «albums» : présentation succinte des albums & explication des filtres latéraux.
array albums_compagnon_messages( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_formulaire_fond()

Compléter ou modifier le résultat de la compilation des squelettes de certains formulaires.
  • Formulaire de configuration des documents : insérer un message d'avertissement après le titre au cas où l'ajout des documents aux albums est désactivé.
array albums_formulaire_fond( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_formulaire_traiter()

Compléter le tableau de réponse ou effectuer des traitements supplémentaires pour certains formulaires.
  • Formulaire d'ajout de documents : quand il s'agit d'un album, rechargement ajax du conteneur des documents. On ajoute du js au message de retour.
array albums_formulaire_traiter( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Note

  • L'identifiant de l'album peut être négatif en cas de création cf. joindre_document.php, L.206 à 222
    Attention, il y a une différence dans les retours avant et après SPIP 3.0.17 A partir de SPIP 3.0.17, on a les identifiants des documents ajoutés dans $flux['data']['ids] Avant, il faut les repérer à la main dans le message de retour.

Source

albums_insert_head_css()

Ajout de feuilles de style CSS sur les pages publiques
string albums_insert_head_css( string $flux )

Paramètres

  1. string $flux

    Feuilles de styles

Retour

  • string

    Description complétée des feuilles de styles

Traversée par le pipeline

Package

Source

albums_jqueryui_plugins()

Plugins Jquery UI nécessaires au plugin
array albums_jqueryui_plugins( $plugins )

Paramètres

  1. $plugins

Retour

  • array

    Liste complétée des js chargés

Traversée par le pipeline

Package

Source

albums_message_cfg_documents()

Fonction privée qui retourne un message d'avertissement au cas où l'ajout de documents aux albums est désactivé.
string | boolean albums_message_cfg_documents( boolean $baliser = false )

Paramètres

  1. boolean $baliser = false

    true pour baliser le texte avec

Retour

  • string | boolean

    le message d'avertissement, sinon false

Package

Source

albums_objet_compte_enfants()

Compter les albums liés à un objet
array albums_objet_compte_enfants( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_optimiser_base_disparus()

Optimiser la base de donnée en supprimant les liens orphelins

On supprime :

  • les albums à la poubelle
  • les liens obsolètes
array albums_optimiser_base_disparus( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

albums_post_edition()

Actions effectuées après l'édition d'un objet.
  • Mise à jour des liens avec les albums.
array albums_post_edition( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Utilise

  • marquer_doublons_album()

Traversée par le pipeline

Package

Note

  • cf. pipeline du plugin Médias

Source

albums_post_insertion()

Actions effectuées après l'insertion d'un nouvel objet en base.
  • Mise à jour les liens temporaires avec les albums.
array albums_post_insertion( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Note

  • Lors d'une première création de l'objet, celui-ci n'ayant pas encore d'identifiant tant que le formulaire d'edition n'est pas enregistré, les liaisions entre les albums liés et l'objet à créer sauvegardent un identifiant d'objet négatif de la valeur de id_auteur (l'auteur connecté). Une fois l'objet inséré en base, il faut rétablir ces liaisons avec le vrai identifiant de l'objet. cf. plugin Médias.

Source

albums_recuperer_fond()

Modifier le résultat du calcul d'un squelette
  • Squelette «inc-upload_documents» : si utilisé pour un album, ajout d'un suffixe unique à l'id du conteneur principal (et à ses références dans le js et cie), afin de pouvoir utiliser le formulaire plusieurs fois sur une même page. Quand utilisé dans le formulaire d'ajout d'album, on change le texte des boutons.
array albums_recuperer_fond( array $flux )

Paramètres

  1. array $flux

    Données du pipeline

Retour

  • array

    Données du pipeline

Traversée par le pipeline

Package

Source

Liste des erreurs

GravitéLigneDescription
Notice 36
  • Référence de @uses introuvable dans albums_afficher_complement_objet : \marquer_doublons_album()
Notice 254
  • Référence de @uses introuvable dans albums_post_edition : \marquer_doublons_album()
Erreur 285
  • Name of argument $plugins does not match with the DocBlock's name $scripts in \albums_jqueryui_plugins()
Notice 285
  • Parameter $scripts could not be found in \albums_jqueryui_plugins()