SPIP Code

Documentation du code de SPIP et de ses plugins

Albums

albums_pipelines.php

Utilisations de pipelines par le plugin Albums

Tags
plugin

Albums

copyright

2014

author

Tetue, Charles Razack

licence

GNU/GPL

Table of Contents

Functions

albums_afficher_complement_objet()  : array<string|int, mixed>
Ajout de contenu aux fiches des objets.
albums_affiche_milieu()  : array<string|int, mixed>
Ajout de contenu sur certaines pages.
albums_affiche_gauche()  : array<string|int, mixed>
Modifier ou ajouter du contenu dans la colonne de gauche.
albums_post_insertion()  : array<string|int, mixed>
Actions effectuées après l'insertion d'un nouvel objet en base.
albums_post_edition()  : array<string|int, mixed>
Actions effectuées après l'édition d'un objet.
albums_post_edition_lien()  : array<string|int, mixed>
Actions effectuées après l'édition des liens.
albums_insert_head_css()  : string
Ajout de feuilles de style CSS sur les pages publiques
albums_objet_compte_enfants()  : array<string|int, mixed>
Compter les albums liés à un objet
albums_boite_infos()  : array<string|int, mixed>
Afficher le nombre d'albums liés publiés dans la boîte infos des rubriques
albums_optimiser_base_disparus()  : array<string|int, mixed>
Optimiser la base de donnée en supprimant les liens orphelins
albums_formulaire_verifier()  : array<string|int, mixed>
Compléter les vérifications des valeurs postées dans les formulaires
albums_recuperer_fond()  : array<string|int, mixed>
Modifier le résultat du calcul d'un squelette
albums_header_prive()  : string
Ajouter des contenus dans la partie <head> des pages de l’espace privé
albums_styliser()  : string
Rediriger possiblement vers un autre modèle album suivant la config de la variante

Functions

albums_afficher_complement_objet()

Ajout de contenu aux fiches des objets.

albums_afficher_complement_objet(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Albums liés aux objets activés dans la configuration du plugin
Parameters
$flux : array<string|int, mixed>

Données du pipeline Données du pipeline, tableau associatif :

  • args : contient au minimum type et id
  • data : contenu html
Tags
pipeline

afficher_complement_objet

Return values
array<string|int, mixed> —

Données du pipeline

albums_affiche_milieu()

Ajout de contenu sur certaines pages.

albums_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Auteurs sur la fiche d'un album
  • Message sur la fiche d'un album si auteur pas autorisé à modifier (cf. autorisation)
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed> —

Données du pipeline

albums_affiche_gauche()

Modifier ou ajouter du contenu dans la colonne de gauche.

albums_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>
  • 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é.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
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 liaisons 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.

pipeline

affiche_gauche

Return values
array<string|int, mixed> —

Données du pipeline

albums_post_insertion()

Actions effectuées après l'insertion d'un nouvel objet en base.

albums_post_insertion(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Mise à jour les liens temporaires avec les albums.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
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.

pipeline

post_insertion

Return values
array<string|int, mixed> —

Données du pipeline

albums_post_edition()

Actions effectuées après l'édition d'un objet.

albums_post_edition(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Vérifier les albums insérés dans le texte et mettre à jour les liens.
  • Publier ou dépublier les rubriques liées aux albums.
Parameters
$flux : array<string|int, mixed>

Données du pipeline, tableau associatif :

  • args : contient au minimum action, table et id_objet
  • data : couples champ => valeur modifiés
Tags
uses
marquer_albums_inseres()
pipeline

post_edition

Return values
array<string|int, mixed> —

Données du pipeline

albums_post_edition_lien()

Actions effectuées après l'édition des liens.

albums_post_edition_lien(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Publier ou dépublier les rubriques liées aux albums. (Nb : faudrait un truc générique dans le core ?)
Parameters
$flux : array<string|int, mixed>

Données du pipeline, tableau associatif :

  • args : contient action, table_lien, objet_source, id_objet_source, objet, id_objet
  • data : valeur de $args['id_objet']
Tags
pipeline

post_edition_lien

Return values
array<string|int, mixed> —

Données du pipeline

albums_insert_head_css()

Ajout de feuilles de style CSS sur les pages publiques

albums_insert_head_css(string $flux) : string
Parameters
$flux : string

Feuilles de styles

Tags
pipeline

insert_head_css

Return values
string —

Description complétée des feuilles de styles

albums_objet_compte_enfants()

Compter les albums liés à un objet

albums_objet_compte_enfants(array<string|int, mixed> $flux) : array<string|int, mixed>

Nb : on ne compte que les publiés afin que la publication/dépublication des rubrique fonctionne correctement

Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

objet_compte_enfants

Return values
array<string|int, mixed> —

Données du pipeline

albums_boite_infos()

Afficher le nombre d'albums liés publiés dans la boîte infos des rubriques

albums_boite_infos(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

boite_infos

Return values
array<string|int, mixed> —

Données du pipeline

albums_optimiser_base_disparus()

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

albums_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>

On supprime :

  • les albums à la poubelle
  • les liens obsolètes
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

optimiser_base_disparus

Return values
array<string|int, mixed> —

Données du pipeline

albums_formulaire_verifier()

Compléter les vérifications des valeurs postées dans les formulaires

albums_formulaire_verifier(array<string|int, mixed> $flux) : array<string|int, mixed>
  • configuration des documents : vérifier que les albums sont sélectionnés
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

albums_recuperer_fond()

Modifier le résultat du calcul d'un squelette

albums_recuperer_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
  • privé / inc-upload_document : identifiant unique + wording si utilisé pour un album.
  • privé / portfolio_document : remplacer par un autre squelette pour les albums.
  • privé / colonne-documents : remplacer par un autre squelette
  • privé / document_desc : ajouter un attribut rel pour les albums
  • privé / documents : ajout de la barre d'onglets
  • public / inclure/documents : on ajoute les albums à la suite
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

recuperer_fond

Return values
array<string|int, mixed> —

Données du pipeline

albums_header_prive()

Ajouter des contenus dans la partie <head> des pages de l’espace privé

albums_header_prive(string $flux) : string
  • Ajout de l'URL de l'action pour ordonner les albums dans la variable de config globale
  • Ajout du chemin vers le script sortable
Parameters
$flux : string
Return values
string

albums_styliser()

Rediriger possiblement vers un autre modèle album suivant la config de la variante

albums_styliser(string $flux) : string
Parameters
$flux : string
Return values
string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results