SPIP Code

Documentation du code de SPIP et de ses plugins

Albums

albums.php

Fonctions du plugin Albums

Tags
plugin

Albums

copyright

2014

author

Tetue, Charles Razack

licence

GNU/GPL

Table of Contents

Functions

supprimer_albums()  : mixed
Supprimer proprement un ou plusieurs albums
vider_albums()  : array<string|int, mixed>
Vider un ou plusieurs albums de leurs documents.
transvaser_album()  : int|bool
Transvaser les documents entre un album et un objet éditorial auquel il est associé
albums_lister_modeles()  : array<string|int, mixed>
Lister les formulaire yaml des modèles «album» disponibles dans les dossiers modeles/
infos_modele_album()  : array<string|int, mixed>
Charger les informations d'un formulaire yaml de modèle «album»

Functions

supprimer_albums()

Supprimer proprement un ou plusieurs albums

supprimer_albums(mixed $ids_albums[, bool $supprimer_docs_orphelins = false ]) : mixed
  • suppression des liens faisant référence à l'album dans spip_documents_liens
  • suppression des liens faisant référence à l'album dans spip_albums_liens
  • suppression de l'album
Parameters
$ids_albums : mixed
$supprimer_docs_orphelins : bool = false

true pour supprimer les documents rendus orphelins

Tags
used-by
action_supprimer_album_dist()

vider_albums()

Vider un ou plusieurs albums de leurs documents.

vider_albums(mixed $ids_albums[, bool $supprimer_docs_orphelins = false ]) : array<string|int, mixed>
Parameters
$ids_albums : mixed
$supprimer_docs_orphelins : bool = false

true pour supprimer les documents rendus orphelins

Tags
note

Impossible de retirer en une fois tous les documents d'un album via le bouton d'action dissocier_document du plugin Médias. Il faut lui passer en paramètre un des 3 modes pour les documents :

  • les images en mode image : I/image
  • les images en mode document : I/document
  • les documents en mode document : 'D/document'

Cf. fonction dissocier_document dans action/dissocier_document.php.

used-by
action_vider_album_dist()
Return values
array<string|int, mixed> —

tableau des albums vidés et ceux laissés intacts [succes => [x,y,z]],[erreurs => [x,y,z]]

transvaser_album()

Transvaser les documents entre un album et un objet éditorial auquel il est associé

transvaser_album(int|string $id_album, string $objet, int $id_objet[, bool $remplir = true ][, bool $supprimer = false ]) : int|bool
Parameters
$id_album : int|string

Identifiant de l'album 0 pour créer un nouvel album vide, dans le cas d'un remplissage

$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$remplir : bool = true

Définit le sens du transvasement (on remplit l'album ou on le vide) true : portfolio -> album false : album -> portfolio

$supprimer : bool = false

true : supprimer l'album dans le cas d'un vidage

Tags
note

On ne fait que modifier des liens existants au lieu de dissocier puis réassocier les documents au moyen des fonctions de Médias (dissocier_document et associer_document)

Return values
int|bool —

nb de liens changés si ok, false en cas d'erreur

albums_lister_modeles()

Lister les formulaire yaml des modèles «album» disponibles dans les dossiers modeles/

albums_lister_modeles() : array<string|int, mixed>

Les premiers modèles retournés sont les modèles du plugin (album.yaml et album_liste.yaml)

Tags
staticvar

array $liste_modeles_albums

Return values
array<string|int, mixed>

infos_modele_album()

Charger les informations d'un formulaire yaml de modèle «album»

infos_modele_album(mixed $fichier) : array<string|int, mixed>
Parameters
$fichier : mixed
Tags
staticvar

array $infos_modeles_album

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results