Documentation du code de SPIP et ses plugins

Albums

Documentation

Packages

SPIP
Application

Table of Contents

_ALBUMS_AFFICHER_DESCRIPTIF  = ''
_ALBUMS_AFFICHER_TITRE  = ''
_ALBUMS_BALISE_TITRE  = 'strong'
_ALBUMS_BALISE_TITRE_LISTE  = ''
_ALBUMS_BALISE_TITRE_VIGNETTES  = ''
_ALBUMS_LISTE_METAS  = ''
_ALBUMS_PAGINATION  = 20
_ALBUMS_PAGINATION_LISTE  = ''
_ALBUMS_PAGINATION_VIGNETTES  = ''
_ALBUMS_POSITION_LEGENDE  = 'top'
_ALBUMS_POSITION_LEGENDE_LISTE  = ''
_ALBUMS_POSITION_LEGENDE_VIGNETTES  = 'bottom'
_ALBUMS_RECADRER  = \false
_ALBUMS_TAILLE_PREVIEW  = 150
_ALBUMS_TITRE_COURT  = \false
action_associer_album_dist()  : void
Associer un album à un objet éditorial
action_dissocier_album_dist()  : void
Dissocier un ou tous les albums liés à un objet éditorial
action_instituer_album_dist()  : void
Changer le statut d'un album
action_supprimer_album_dist()  : void
Supprime un album proprement
action_vider_album_dist()  : void
«Vider» un album : dissocier tous ses documents
albums_upgrade()  : void
Fonction d'installation et de mise à jour du plugin.
albums_vider_tables()  : void
Fonction de désinstallation du plugin.
meta_documents_albums()  : void
Fonction privée : ajouter les albums à la liste des objets pouvant recevoir des documents
albums_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_albumcreer_menu_dist()  : bool
Autorisation à afficher l'icone de création rapide.
autoriser_albums_menu_dist()  : bool
Autorisation de voir les albums dans le menu d'édition.
autoriser_album_creer_dist()  : bool
Autorisation de créer un album
autoriser_album_voir_dist()  : bool
Autorisation à voir les fiches complètes.
autoriser_albumotheque_administrer_dist()  : bool
Autorisation à accéder à l'albumothèque.
autoriser_ajouteralbum_dist()  : bool
Autorisation à ajouter un album à un objet.
autoriser_album_modifier_dist()  : bool
Autorisation à modifier un album.
autoriser_album_supprimer_dist()  : bool
Autorisation à supprimer définitivement un album.
autoriser_album_associer_dist()  : bool
Autorisation à associer un album à un objet donné.
autoriser_album_dissocier_dist()  : bool
Autorisation à dissocier un album d'un objet donné.
autoriser_autoassocieralbum_dist()  : bool
Auto-association d'albums à du contenu éditorial qui le référence.
autoriser_album_vider_dist()  : bool
Autorisation de vider un album
autoriser_album_transvaser_dist()  : bool
Autorisation de transvaser les documents d'un album
critere_ALBUMS_orphelins_dist()  : mixed
critère `{orphelins}`
critere_ALBUMS_contenu_dist()  : mixed
critère {contenu} sélectionne les albums en fonction de leur contenu (image, audio, file, video) {contenu} -> albums remplis {!contenu} -> albums vides {contenu xxx} -> albums contenant des xxx : medias sous forme de regexp en fonction de la valeur de *contenu* dans l environnement : oui : albums remplis non : albums vides xxx -> albums contenant des xxx : medias sous forme de regexp
albums_calculer_critere_contenu_select()  : string
fonction privée pour le calcul du critère {contenu} renvoie un sql select en fonction des documents liés au albums
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_jqueryui_plugins()  : array<string|int, mixed>
Plugins Jquery UI nécessaires au plugin
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 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_fond()  : array<string|int, mixed>
Compléter ou modifier le résultat de la compilation des squelettes de certains formulaires.
albums_message_cfg_documents()  : string|bool
Fonction privée qui retourne un message d'avertissement au cas où l'ajout de documents aux albums est désactivé.
albums_formulaire_traiter()  : array<string|int, mixed>
Compléter le tableau de réponse ou effectuer des traitements supplémentaires pour certains formulaires.
albums_compagnon_messages()  : array<string|int, mixed>
Compléter ou modifier la liste des messages des compagnons.
albums_album_boutons_actions()  : array<string|int, mixed>
Utilisation du pipeline album_boutons_actions
albums_recuperer_fond()  : array<string|int, mixed>
Modifier le résultat du calcul d'un squelette
filtre_albums_autocomplete()  : array<string|int, mixed>
Retourne une liste d'objets, correspondants éventuellement à un terme de recherche.
albums_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des alias de tables et filtres automatiques de champs
albums_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclaration des objets éditoriaux
albums_declarer_tables_auxiliaires()  : array<string|int, mixed>
Déclaration des tables secondaires (liaisons)
formulaires_ajouter_album_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'ajout d'album
formulaires_ajouter_album_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire d'ajout d'album
formulaires_ajouter_album_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'ajout d'album
js_ajouter_albums()  : string
Fonction privée retournant le js pour recharger les blocs adéquats
formulaires_balise_album_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'insertion de balise d'un album
formulaires_balise_album_verifier_3_dist()  : array<string|int, mixed>
Vérifications du formulaire d'insertion de balise d'un album : étape 2
formulaires_balise_album_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'insertion de balise d'un album
js_balise()  : int
Micro fonction qui renvoie le code js pour insérer une balise dans le texte
formulaires_editer_album_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
formulaires_editer_album_charger_dist()  : array<string|int, mixed>
Chargement du formulaire d'édition d'un album
formulaires_editer_album_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire d'édition d'un album
formulaires_editer_album_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire d'édition d'un album
formulaires_migrer_albums_charger_dist()  : array<string|int, mixed>
Chargement du formulaire de migration d'articles en albums
formulaires_migrer_albums_verifier_dist()  : array<string|int, mixed>
Vérifications du formulaire de migration d'articles en albums
formulaires_migrer_albums_traiter_dist()  : array<string|int, mixed>
Traitement du formulaire de migration d'articles en albums
albums_migrer_articles()  : int
Fonction privée
migrer_albums_where_articles()  : array<string|int, mixed>
Fonction privée
migrer_albums_where_mots()  : array<string|int, mixed>
Fonction privée
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»
inc_marquer_doublons_album_dist()  : void
Mettre à jour les liens des albums pour un objet
inc_precharger_album_dist()  : array<string|int, mixed>
Retourne les valeurs à charger pour un formulaire d'édition d'un album
inc_precharger_traduction_album_dist()  : array<string|int, mixed>
Récupère les valeurs d'une traduction de référence pour la création d'un album (préremplissage du formulaire).

Constants

_ALBUMS_POSITION_LEGENDE_VIGNETTES

public mixed _ALBUMS_POSITION_LEGENDE_VIGNETTES = 'bottom'

Functions

action_associer_album_dist()

Associer un album à un objet éditorial

action_associer_album_dist([string $arg = null ]) : void
Parameters
$arg : string = null

Arguments séparés par un charactère non alphanumérique sous la forme $id_album/$objet/$id_objet

  • id_album : identifiant de l'album
  • objet : type d'objet à associer
  • id_objet : identifiant de l'objet à associer
Tags
example
#URL_ACTION_AUTEUR{associer_album, #ID_ALBUM/#OBJET/#ID_OBJET, #SELF}
Return values
void

action_dissocier_album_dist()

Dissocier un ou tous les albums liés à un objet éditorial

action_dissocier_album_dist([string $arg = null ]) : void
Parameters
$arg : string = null

Arguments séparés par un slash «/» sous la forme $album/$objet/$id_objet

  • album : identifiant d'un album pour dissocier un album unique «tous» pour dissocier tous les albums
  • objet : type d'objet à dissocier
  • id_objet : identifiant de l'objet à dissocier
Tags
example
#URL_ACTION_AUTEUR{dissocier_album, #ID_ALBUM/#OBJET/#ID_OBJET, #SELF}
#URL_ACTION_AUTEUR{dissocier_album, tous/#OBJET/#ID_OBJET, #SELF}
Return values
void

action_instituer_album_dist()

Changer le statut d'un album

action_instituer_album_dist([string $arg = null ]) : void
Parameters
$arg : string = null

Arguments séparés par un charactère non alphanumérique sous la forme $id_album/$statut

  • id_album : identifiant de l'album
  • statut : nouveau statut (prepa|publie|poubelle)
Tags
example
#URL_ACTION_AUTEUR{instituer_album, #ID_ALBUM/publie, #SELF}
Return values
void

action_supprimer_album_dist()

Supprime un album proprement

action_supprimer_album_dist([ $arg = null ]) : void
Parameters
$arg : = null

string Arguments séparés par un charactère non alphanumérique sous la forme $id_album/orphelins

  • id_album : identifiant de l'album
  • orphelins : «orphelins» pour supprimer les documents rendus orphelins
Tags
example
#URL_ACTION_AUTEUR{supprimer_album,#ID_ALBUM,#SELF}
#URL_ACTION_AUTEUR{supprimer_album,#ID_ALBUM/orphelins,#SELF}
uses
supprimer_albums()
Return values
void

action_vider_album_dist()

«Vider» un album : dissocier tous ses documents

action_vider_album_dist([ $arg = null ]) : void

Optionnellement, on peut supprimer les documents rendus orphelins, ainsi que l'album.

Parameters
$arg : = null

string Arguments séparés par un charactère non alphanumérique sous la forme $id_album-supprimer-orphelins

  • id_album : identifiant de l'album
  • orphelins : pour supprimer les documents rendus orphelins
  • supprimer : pour supprimer l'album à la fin de l'opération
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 : D/image
  • les documents non image en mode document : 'D/document'

Cf. fonction dissocier_document dans action/dissocier_document.php.

example
#URL_ACTION_AUTEUR{vider_album, #ID_ALBUM, #SELF}
uses
vider_albums()
Return values
void

albums_upgrade()

Fonction d'installation et de mise à jour du plugin.

albums_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

Return values
void

albums_vider_tables()

Fonction de désinstallation du plugin.

albums_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

Return values
void

meta_documents_albums()

Fonction privée : ajouter les albums à la liste des objets pouvant recevoir des documents

meta_documents_albums() : void
Return values
void

albums_autoriser()

Fonction d'appel pour le pipeline

albums_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_albumcreer_menu_dist()

Autorisation à afficher l'icone de création rapide.

autoriser_albumcreer_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être autorisé à créer un album.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Tags
see
autoriser_album_creer_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_albums_menu_dist()

Autorisation de voir les albums dans le menu d'édition.

autoriser_albums_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être autorisé à administrer les albums.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Tags
see
autoriser_albums_administrer_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_creer_dist()

Autorisation de créer un album

autoriser_album_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être admin ou rédacteur.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_album_voir_dist()

Autorisation à voir les fiches complètes.

autoriser_album_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Open bar pour tout le monde.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_albumotheque_administrer_dist()

Autorisation à accéder à l'albumothèque.

autoriser_albumotheque_administrer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être admin ou rédacteur.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_ajouteralbum_dist()

Autorisation à ajouter un album à un objet.

autoriser_ajouteralbum_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut que l'ajout d'albums sur le type d'objet soit activé, et pouvoir modifier l'objet (ou l'éditer en cas de création par un rédacteur, qui correspond au hack id_objet = 0-id_auteur) ou être admin complet.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet auquel on veut ajouter un album

$id : int

Identifiant de l'objet auquel on veut ajouter un album

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Tags
note

Attention, les 2ème et 3ème arguments se réfèrent à l'objet, pas à l'album. Pour le hack de l'identifiant négatif, voir les notes du pipeline «affiche_gauche». Autre hack pénible : des fois l'autorisation à modifier un objet renvoie un faux négatif, c'est la cas dans un appel depuis le pipeline post_insertion, car l'auteur n'a pas encore été lié à l'objet. Dans ce cas il faut contourner le problème en vérifiant si l'objet vient juste d'être créé. cf. autorisation à modifier un album : même combat.

TODO Le problème du hack est réglé avec SPIP 3.1, n'y avoir recours que pour les versions antérieures.

example
#AUTORISER{ajouteralbum,#OBJET,#ID_OBJET}
Return values
bool

true s'il a le droit, false sinon

autoriser_album_modifier_dist()

Autorisation à modifier un album.

autoriser_album_modifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être l'auteur et avoir le droit de modifier tous les objets auxquels l'album est lié, ou qu'il s'agisse d'un album en cours de création (vide, pas d'auteur et récent, cf. note), ou être admin complet, ou que l'album soit lié à une rubrique wiki/ouverte ou un de ses article et utilisé une seule fois (plugin autorité).

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Tags
note

Hack pénible : quand on ajoute des documents à un nouvel album pas encore enregistré en base, Des liens temporaires sont créés dans la table spip_documents_liens. Ceux-ci seront modifiés une fois l'album inséré en base, via le pipeline «post_insertion» du plugin Médias. Il vérifie avant de procéder qu'il y ait l'autorisation de modifier l'album. Mais lorsque ce pipeline est appelé, aucun auteur n'a encore été lié à l'album. Pour ne pas renvoyer un faux négatif dans ce cas là, on vérifie si l'album vient juste d'être créé selon ces critères : âge, sans auteur et vide. cf. autorisation à ajouter un album : même combat.

TODO Le problème du hack est réglé avec SPIP 3.1, n'y avoir recours que pour les versions antérieures.

Return values
bool

true s'il a le droit, false sinon

autoriser_album_supprimer_dist()

Autorisation à supprimer définitivement un album.

autoriser_album_supprimer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut qu'il soit vide et inutilisé, et avoir le droit de le modifier ou être admin complet

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_album_associer_dist()

Autorisation à associer un album à un objet donné.

autoriser_album_associer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut pouvoir modifier l'objet ou être admin complet

Parameters
$faire : string

Action demandée

$type : string

Type d'objet auquel on veut associer ou dissocier un album

$id : int

Identifiant de l'objet auquel on veut associer ou dissocier un album

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation Doit contenir les clés objet et id_objet pour rensigner le type et l'identifiant de l'objet

Tags
note

Les infos sur l'objet dont dans les options (5ème paramètre)

example
#AUTORISER{associer,album,#ID_ALBUM,'',#ARRAY{objet,#OBJET,id_objet,#ID_OBJET}}
Return values
bool

true s'il a le droit, false sinon

autoriser_album_dissocier_dist()

Autorisation à dissocier un album d'un objet donné.

autoriser_album_dissocier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut être autorisé à associer un album à l'objet, et qu'il ne soit pas inséré dans le texte.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation Doit contenir les clés objet et id_objet pour renseigner le type et l'identifiant de l'objet

Tags
note

Les infos sur l'objet dont dans les options (5ème paramètre)

example
#AUTORISER{dissocier,album,#ID_ALBUM,'',#ARRAY{objet,#OBJET,id_objet,#ID_OBJET}}
Return values
bool

true s'il a le droit, false sinon

autoriser_autoassocieralbum_dist()

Auto-association d'albums à du contenu éditorial qui le référence.

autoriser_autoassocieralbum_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Par défaut true pour tous les objets.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_album_vider_dist()

Autorisation de vider un album

autoriser_album_vider_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut qu'il y ait des documents, et être admin complet

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_album_transvaser_dist()

Autorisation de transvaser les documents d'un album

autoriser_album_transvaser_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opts) : bool

Il faut que l'album soit lié à l'objet et avoir le droit de modifier l'album et d'ajouter des documents ou être admin complet.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet sur lequel appliquer l'action

$id : int

Identifiant de l'objet

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$opts : array<string|int, mixed>

Options de cette autorisation Doit contenir les clés objet et id_objet pour renseigner le type et l'identifiant de l'objet

Return values
bool

true s'il a le droit, false sinon

critere_ALBUMS_orphelins_dist()

critère `{orphelins}`

critere_ALBUMS_orphelins_dist(string $idb, object &$boucles, object $crit) : mixed

Sélectionne les albums sans lien avec un objet éditorial

Parameters
$idb : string
$boucles : object
$crit : object
Tags
critere
Return values
mixed

critere_ALBUMS_contenu_dist()

critère {contenu} sélectionne les albums en fonction de leur contenu (image, audio, file, video) {contenu} -> albums remplis {!contenu} -> albums vides {contenu xxx} -> albums contenant des xxx : medias sous forme de regexp en fonction de la valeur de *contenu* dans l environnement : oui : albums remplis non : albums vides xxx -> albums contenant des xxx : medias sous forme de regexp

critere_ALBUMS_contenu_dist(string $idb, object &$boucles, object $crit) : mixed
Parameters
$idb : string
$boucles : object
$crit : object
Tags
deprecated

: utiliser plutot <BOUCLE_album(ALBUMS documents){documents.media=image}>

Return values
mixed

albums_calculer_critere_contenu_select()

fonction privée pour le calcul du critère {contenu} renvoie un sql select en fonction des documents liés au albums

albums_calculer_critere_contenu_select([string $media = '' ]) : string

note : la selection des albums vides (avec contenu=non) fait une requete a rallonge... a revoir

Parameters
$media : string = ''

types de medias contenus dans les albums, separes par des virgules

Return values
string

select

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
  • Documents liés aux albums en cas d'absence du portfolio (cf. note)
Parameters
$flux : array<string|int, mixed>

Données du pipeline

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

uses
marquer_doublons_album()
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 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.

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>
  • Mise à jour des liens avec les albums.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
note

cf. pipeline du plugin Médias

uses
marquer_doublons_album()
pipeline

post_edition

Return values
array<string|int, mixed>

Données du pipeline

albums_jqueryui_plugins()

Plugins Jquery UI nécessaires au plugin

albums_jqueryui_plugins(mixed $plugins) : array<string|int, mixed>
Parameters
$plugins : mixed
Tags
pipeline

jqueryui_plugins

Return values
array<string|int, mixed>

Liste complétée des js chargés

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>
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 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_fond()

Compléter ou modifier le résultat de la compilation des squelettes de certains formulaires.

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

Données du pipeline

Tags
pipeline

formulaire_fond

Return values
array<string|int, mixed>

Données du pipeline

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

albums_message_cfg_documents([bool $baliser = false ]) : string|bool
Parameters
$baliser : bool = false

true pour baliser le texte avec

Return values
string|bool

le message d'avertissement, sinon false

albums_formulaire_traiter()

Compléter le tableau de réponse ou effectuer des traitements supplémentaires pour certains formulaires.

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

Données du pipeline

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

pipeline

formulaire_fond

Return values
array<string|int, mixed>

Données du pipeline

albums_compagnon_messages()

Compléter ou modifier la liste des messages des compagnons.

albums_compagnon_messages(array<string|int, mixed> $flux) : array<string|int, mixed>
  • Page «albums» : présentation succinte des albums & explication des filtres latéraux.
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

compagnon_messages

Return values
array<string|int, mixed>

Données du pipeline

albums_album_boutons_actions()

Utilisation du pipeline album_boutons_actions

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

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

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

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

Tags
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'
)
pipeline

album_boutons_actions

Return values
array<string|int, mixed>

Données du pipeline

albums_recuperer_fond()

Modifier le résultat du calcul d'un squelette

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

Données du pipeline

Tags
pipeline

recuperer_fond

Return values
array<string|int, mixed>

Données du pipeline

filtre_albums_autocomplete()

Retourne une liste d'objets, correspondants éventuellement à un terme de recherche.

filtre_albums_autocomplete([string $type = '' ][, string $type2 = '' ][, bool $pivot2 = false ][, string $terme = '' ][, string $champ = '' ][, int|string $nb = '' ]) : array<string|int, mixed>

On peut restreindre la sélection en fonction des liaisons avec un autre type d'objet. Si un terme est donné, on cherche les occurences dans 2 champs :

  • le champ servant de clé primaire id_xxx.
  • le champ contenant le titre tel que défini dans la déclaration de la table, ou un champ spécifique donné en argument.
Parameters
$type : string = ''

Type d'objet recherché

$type2 : string = ''

Type d'objet lié

$pivot2 : bool = false

true pour définir l'objet secondaire comme pivot. Le pivot est l'objet qui porte la table de liens dont on se sert pour récupérer les liaisons. Par défaut on cherche dans la table de liens de l'objet principal.

$terme : string = ''

Terme de recherche (optionnel)

$champ : string = ''

Champ spécial dans lequel le terme doit être recherché. Par défaut, on cherche dans le champ correspondant au titre de l'objet, tel que précisé dans la déclaration de la table sql.

$nb : int|string = ''

Nombre maximal de résultats, 20 par défaut.

Tags
example
  • Albums avec toto dans le titre : ...autocomplete('album','','','toto')
  • Articles avec toto dans le titre et ayant des albums liés : ...autocomplete('article','album',true,'toto')
  • Auteurs ayant toto dans leur email et liés à des albums : ...autocomplete('auteur','album','','toto','email')
  • Mot-clés liés à des albums : ...autocomplete('mot','album')
Return values
array<string|int, mixed>

tableau contenant une sélection des objets avec leur identifiant et leur titre.

albums_declarer_tables_interfaces()

Déclaration des alias de tables et filtres automatiques de champs

albums_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Déclarations d'interface pour le compilateur

albums_declarer_tables_objets_sql()

Déclaration des objets éditoriaux

albums_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Description complétée des tables

albums_declarer_tables_auxiliaires()

Déclaration des tables secondaires (liaisons)

albums_declarer_tables_auxiliaires(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
pipeline

declarer_tables_auxiliaires

Return values
array<string|int, mixed>

Description complétée des tables

formulaires_ajouter_album_charger_dist()

Chargement du formulaire d'ajout d'album

formulaires_ajouter_album_charger_dist([int|string $objet = '' ], int|string $id_objet[, string $retour = '' ], int $lier_trad) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$objet : int|string = ''

type de l'objet à associer.

$id_objet : int|string

Identifiant de l'objet à associer.

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

Tags
uses
formulaires_editer_album_charger()
uses
formulaires_joindre_document_charger()
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_ajouter_album_verifier_dist()

Vérifications du formulaire d'ajout d'album

formulaires_ajouter_album_verifier_dist([int|string $objet = '' ], int|string $id_objet[, string $retour = '' ], int $lier_trad) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs

Parameters
$objet : int|string = ''

type de l'objet à associer.

$id_objet : int|string

Identifiant de l'objet à associer.

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

Tags
uses
formulaires_editer_album_verifier()
uses
formulaires_joindre_document_verifier()
Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_ajouter_album_traiter_dist()

Traitement du formulaire d'ajout d'album

formulaires_ajouter_album_traiter_dist([int|string $objet = '' ], int|string $id_objet[, string $retour = '' ], int $lier_trad) : array<string|int, mixed>

Traiter les champs postés

Parameters
$objet : int|string = ''

type de l'objet à associer.

$id_objet : int|string

Identifiant de l'objet à associer.

$retour : string = ''

URL de redirection après le traitement

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

Tags
uses
formulaires_editer_album_traiter()
uses
formulaires_joindre_document_traiter()
Return values
array<string|int, mixed>

Retours des traitements

js_ajouter_albums()

Fonction privée retournant le js pour recharger les blocs adéquats

js_ajouter_albums([string|array<string|int, mixed> $ids = array() ]) : string
Parameters
$ids : string|array<string|int, mixed> = array()

identifiants des albums ajoutés

Return values
string

message js

formulaires_balise_album_charger_dist()

Chargement du formulaire d'insertion de balise d'un album

formulaires_balise_album_charger_dist(int|string $id_album) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$id_album : int|string

Identifiant de l'album.

Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_balise_album_verifier_3_dist()

Vérifications du formulaire d'insertion de balise d'un album : étape 2

formulaires_balise_album_verifier_3_dist(int|string $id_album) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs

Parameters
$id_album : int|string

Identifiant de l'album.

Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_balise_album_traiter_dist()

Traitement du formulaire d'insertion de balise d'un album

formulaires_balise_album_traiter_dist(int|string $id_album) : array<string|int, mixed>

Traiter les champs postés

Parameters
$id_album : int|string

Identifiant de l'album.

Return values
array<string|int, mixed>

Retours des traitements

js_balise()

Micro fonction qui renvoie le code js pour insérer une balise dans le texte

js_balise(mixed $balise) : int
Parameters
$balise : mixed
Return values
int

formulaires_editer_album_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité

formulaires_editer_album_identifier_dist([int|string $id_album = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : string
Parameters
$id_album : int|string = 'new'

Identifiant de l'album. 'new' pour un nouvel album.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier l'album créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL de l'album, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values
string

Hash du formulaire

formulaires_editer_album_charger_dist()

Chargement du formulaire d'édition d'un album

formulaires_editer_album_charger_dist([int|string $id_album = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$id_album : int|string = 'new'

Identifiant de l'album. 'new' pour un nouvel album.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le album créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL de l'album, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_charger()
Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_editer_album_verifier_dist()

Vérifications du formulaire d'édition d'un album

formulaires_editer_album_verifier_dist([int|string $id_album = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs

Parameters
$id_album : int|string = 'new'

Identifiant de l'album. 'new' pour un nouvel album.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le album créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL de l'album, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_verifier()
Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_editer_album_traiter_dist()

Traitement du formulaire d'édition d'un album

formulaires_editer_album_traiter_dist([int|string $id_album = 'new' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, string $hidden = '' ]) : array<string|int, mixed>

Traiter les champs postés

Parameters
$id_album : int|string = 'new'

Identifiant de l'album. 'new' pour un nouvel album.

$retour : string = ''

URL de redirection après le traitement

$associer_objet : string = ''

Éventuel objet|x indiquant de lier le album créé à cet objet, tel que article|3

$lier_trad : int

Identifiant éventuel d'un album source d'une traduction

$config_fonc : string = ''

Nom de la fonction ajoutant des configurations particulières au formulaire

$row : array<string|int, mixed> = array()

Valeurs de la ligne SQL de l'album, si connu

$hidden : string = ''

Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Tags
uses
formulaires_editer_objet_traiter()
Return values
array<string|int, mixed>

Retours des traitements

formulaires_migrer_albums_charger_dist()

Chargement du formulaire de migration d'articles en albums

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

Déclarer les champs postés et y intégrer les valeurs par défaut

Return values
array<string|int, mixed>

Environnement du formulaire

formulaires_migrer_albums_verifier_dist()

Vérifications du formulaire de migration d'articles en albums

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

Vérifier les champs postés et signaler d'éventuelles erreurs

Return values
array<string|int, mixed>

Tableau des erreurs

formulaires_migrer_albums_traiter_dist()

Traitement du formulaire de migration d'articles en albums

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

Traiter les champs postés

Return values
array<string|int, mixed>

Retours des traitements

albums_migrer_articles()

Fonction privée

albums_migrer_articles(mixed $where_articles, mixed $where_mots, mixed $refuser, mixed $lier_rubriques) : int
Parameters
$where_articles : mixed
$where_mots : mixed
$refuser : mixed
$lier_rubriques : mixed
Return values
int

nombre d'articles migrés

migrer_albums_where_articles()

Fonction privée

migrer_albums_where_articles(mixed $id_rubrique[, mixed $branche = false ]) : array<string|int, mixed>
Parameters
$id_rubrique : mixed
$branche : mixed = false
Return values
array<string|int, mixed>

migrer_albums_where_mots()

Fonction privée

migrer_albums_where_mots(mixed $groupes) : array<string|int, mixed>
Parameters
$groupes : mixed
Return values
array<string|int, mixed>

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

Return values
mixed

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.

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>

inc_marquer_doublons_album_dist()

Mettre à jour les liens des albums pour un objet

inc_marquer_doublons_album_dist( $champs,  $id,  $type,  $id_table_objet,  $table_objet,  $table_objet_sql[,  $desc = array() ][,  $serveur = '' ]) : void
Parameters
$champs :

Couples Champs / valeur de l'objet

$id :

Identifiant de l'objet

$type :

Type d'objet (article)

$id_table_objet :

clé primaire de l'objet (id_article)

$table_objet :

Nom de l'objet (articles)

$table_objet_sql :

Nom de la table de l'objet (spip_articles)

$desc : = array()

Description de la table de l'objet

$serveur : = ''

Nom du connecteur

Return values
void

inc_precharger_album_dist()

Retourne les valeurs à charger pour un formulaire d'édition d'un album

inc_precharger_album_dist(string|int $id_album, int $id_rubrique, int $lier_trad) : array<string|int, mixed>

Lors d'une création, certains champs peuvent être préremplis (c'est le cas des traductions)

Parameters
$id_album : string|int

Identifiant de l'album, ou "new" pour une création

$id_rubrique : int

Identifiant éventuel de la rubrique parente

$lier_trad : int

Identifiant éventuel de la traduction de référence

Return values
array<string|int, mixed>

Couples clés / valeurs des champs du formulaire à charger.

inc_precharger_traduction_album_dist()

Récupère les valeurs d'une traduction de référence pour la création d'un album (préremplissage du formulaire).

inc_precharger_traduction_album_dist(string|int $id_album, int $id_rubrique, int $lier_trad) : array<string|int, mixed>
Parameters
$id_album : string|int

Identifiant de l'album, ou "new" pour une création

$id_rubrique : int

Identifiant éventuel de la rubrique parente

$lier_trad : int

Identifiant éventuel de la traduction de référence

Tags
note

Fonction facultative si pas de changement dans les traitements

Return values
array<string|int, mixed>

Couples clés / valeurs des champs du formulaire à charger

Search results