Documentation du code de SPIP et de ses plugins

Albums

Documentation

Packages

SPIP
Application

Table of Contents

action_associer_album_dist()  : bool
Associer un album à un objet éditorial
action_desordonner_liens_albums_dist()  : void
Remettre à zéro l'ordre des albums liés à un objet
desordonner_liens_albums()  : void
Remettre à zéro l'ordre des albums liés à un objet
action_dissocier_album_dist()  : bool
Dissocier un ou tous les albums liés à un objet éditorial
action_instituer_album_dist()  : void
Changer le statut d'un album
action_ordonner_liens_albums_dist()  : string
Ordonner les albums liés à un objet selon un ordre donné
ordonner_liens_albums_json_envoi()  : mixed
ordonner_liens_albums_json_erreur()  : mixed
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.
albums_verifier_config_documents()  : array<string|int, mixed>
Vérifie que les albums figurent dans la config des objets des documents.
albums_ecrire_config_defaut()  : bool
Écrit les valeurs par défaut de la configuration des albums
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 un album
autoriser_albumotheque_administrer_dist()  : bool
Autorisation à accéder à l'albumothèque.
autoriser_ajouteralbum_dist()  : bool
Autorisation d'ajouter un album, optionnellement en le liant à 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_dissocieralbums_dist()  : bool
Autorisation à dissocier *tous* les albums 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
tester_autorisation_album()  : bool
Différents tests utiles aux autorisations des albums
tester_album_wiki()  : bool
Teste si un album se trouve dans un secteur wiki auquel on a accès (plugin autorité)
critere_ALBUMS_orphelins_dist()  : mixed
critère `{orphelins}`
inc_bigup_medias_formulaire_ajouter_album_dist()  : Formulaire
Activer bigup sur le formulaire d'ajout d'album
albums_decrire_dispositions()  : array<string|int, mixed>
Description des dispositions connues pour le modèle album.
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_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_identifier_dist()  : string
Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
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_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_albums_dist()  : array<string|int, mixed>
Vérifier les albums insérés dans le texte d'un objet et mettre à jour les liens.
inc_objet_marquer_albums_inseres_dist()  : array<string|int, mixed>
Vérifier les albums insérés dans le texte d'un objet et mettre à jour les liens.
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).
balise_ALBUM_DOC_dist()  : object
Compile la balise `#ALBUM_DOC` qui retourne le code HTML d'un modèle de document ajusté pour les albums.
calculer_album_doc()  : string
Fonction privée pour calculer le HTML de la balise #ALBUM_DOC
balise_ALBUM_PARAMS_dist()  : object
Compile la balise `#ALBUM_PARAMS` qui retourne soit un ensemble de valeurs utiles au modèle album, soit une seule.
calculer_album_params()  : array<string|int, mixed>|string
Fonction privée pour calculer la balise `#ALBUM_PARAMS`
albums_classe_ratio()  : string
Renvoie une classe correspondant à un ratio
filtre_inserer_attributs_album()  : string
Ajoute les attributs nécessaires à une boîte album dans le privé

Functions

action_associer_album_dist()

Associer un album à un objet éditorial

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

Arguments séparés par un slash / 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
bool

action_desordonner_liens_albums_dist()

Remettre à zéro l'ordre des albums liés à un objet

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

Fournit les arguments de la fonction desordonner_liens_albums, séparés par des tirets. Ex. : album-article-10-rang_lien

Return values
void

desordonner_liens_albums()

Remettre à zéro l'ordre des albums liés à un objet

desordonner_liens_albums(string $objet, string $objet_lie,  $id_objet_lie, string|null $champ_rang) : void
Parameters
$objet : string

Type d'objet à dissocier (celui qui posséde la table de liens, les albums quoi)

$objet_lie : string

Objet duquel dissocier

$id_objet_lie :

Numéro de l'objet duquel dissocier

$champ_rang : string|null
Return values
void

action_dissocier_album_dist()

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

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

Arguments séparés par un slash /, sous la forme id_album_ou_tous/objet/id_objet

  • id_album_ou_tous : soit l'identifiant d'un album soit le mot-clé tous pour dissocier en masse
  • 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
bool

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

Ordonner les albums liés à un objet selon un ordre donné

action_ordonner_liens_albums_dist() : string
Tags
note

On ne passe pas pas sécuriser_action(), celle-ci est appelée par un script JS anonyme. On vérifie toutefois l'autorisation de modifier l'objet lié.

Return values
string

Objet json avec 3 clés done, success et errors

ordonner_liens_albums_json_envoi()

ordonner_liens_albums_json_envoi(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed

ordonner_liens_albums_json_erreur()

ordonner_liens_albums_json_erreur(mixed $msg) : mixed
Parameters
$msg : mixed
Return values
mixed

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

albums_verifier_config_documents()

Vérifie que les albums figurent dans la config des objets des documents.

albums_verifier_config_documents([array<string|int, mixed>|null $config = null ][, bool $ecrire = true ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed>|null = null

valeurs sous forme de tableau (à défaut on prend la config actuelle)

$ecrire : bool = true

true pour enregistrer la nouvelle config (défaut)

Return values
array<string|int, mixed>

Valeurs complétées

albums_ecrire_config_defaut()

Écrit les valeurs par défaut de la configuration des albums

albums_ecrire_config_defaut() : bool
Return values
bool

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> $options) : 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
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> $options) : 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
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> $options) : 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_voir_dist()

Autorisation à voir un album

autoriser_album_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $options) : 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

$options : 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> $options) : 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_ajouteralbum_dist()

Autorisation d'ajouter un album, optionnellement en le liant à un objet.

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

Cette autorisation est prévue pour le formulaire ajouter_album.

Il faut avoir le droit de créer un album, et si un objet est indiqué, que l'ajout d'albums soit activé sur ce type, et avoir le droit de modifier l'objet ou être admin complet.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet à lier à l'album (optionnel)

$id : int

Identifiant de l'objet à lier à l'album

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$options : array<string|int, mixed>

Options de cette autorisation

Tags
example
#AUTORISER{ajouteralbum}
#AUTORISER{ajouteralbum, #OBJET, #ID_OBJET}
uses
tester_autorisation_album()
uses
autoriser_album_creer_dist()
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> $options) : bool

Il faut être l'auteur ou admin complet, ou si plugin autorité, que l'album soit dans un secteur wiki

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
staticvar

$autorisations

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> $options) : bool

Il faut avoir le droit de le modifier et qu'il soit à la poubelle, ou vide et inutilisé.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
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> $options) : 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

$options : 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}}
uses
tester_autorisation_album()
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> $options) : bool

Il faut pouvoir modifier l'objet ou être admin complet, et que l'album 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

$options : 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}}
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_dissocieralbums_dist()

Autorisation à dissocier *tous* les albums d'un objet donné.

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

Il faut plusieurs albums liés, et pouvoir modifier l'objet 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
example
#AUTORISER{dissocieralbums,#OBJET,#ID_OBJET}
uses
tester_autorisation_album()
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> $options) : 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

$options : 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> $options) : 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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

tester_autorisation_album()

Différents tests utiles aux autorisations des albums

tester_autorisation_album(string $test, array<string|int, mixed> $args) : bool
Parameters
$test : string
$args : array<string|int, mixed>
Return values
bool

tester_album_wiki()

Teste si un album se trouve dans un secteur wiki auquel on a accès (plugin autorité)

tester_album_wiki(int $id_album, array<string|int, mixed> $qui) : bool
Parameters
$id_album : int
$qui : array<string|int, mixed>
Tags
note

Il faudrait une fonction générique dans autorité.

Return values
bool

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

inc_bigup_medias_formulaire_ajouter_album_dist()

Activer bigup sur le formulaire d'ajout d'album

inc_bigup_medias_formulaire_ajouter_album_dist(array<string|int, mixed> $args, Formulaire $formulaire) : Formulaire
Parameters
$args : array<string|int, mixed>
$formulaire : Formulaire
Return values
Formulaire

albums_decrire_dispositions()

Description des dispositions connues pour le modèle album.

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

On indique les traitements images éventuels, le modèle de doc à utiliser, etc. (parité avec les noms des paramètres du modèle album)

Return values
array<string|int, mixed>

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_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_identifier_dist()

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

formulaires_ajouter_album_identifier_dist([int|string $objet = '' ], int|string $id_objet[, string $redirection = '' ], int $lier_trad[, array<string|int, mixed> $options = [] ]) : string
Parameters
$objet : int|string = ''

type d'un objet à associer (optionnel).

$id_objet : int|string

Identifiant d'un objet à associer (optionnel).

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$options : array<string|int, mixed> = []

Tableau d'options

  • url_fermer (string) : ajoute un bouton ajax de fermeture
  • ajaxreload (array|string) : identifiants de blocs ajax à recharger.
  • ajaxreload_params (array) : paramètres à transmettre aux blocs rechargés.
Return values
string

Hash du formulaire

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 $redirection = '' ], int $lier_trad[, array<string|int, mixed> $options = [] ]) : 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.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$options : array<string|int, mixed> = []

Tableau d'options

  • url_fermer (string) : ajoute un bouton ajax de fermeture
  • ajaxreload (array|string) : identifiants de blocs ajax à recharger.
  • ajaxreload_params (array) : paramètres à transmettre aux blocs rechargés.
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 $redirection = '' ], int $lier_trad[, array<string|int, mixed> $options = [] ]) : 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.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$options : array<string|int, mixed> = []

Tableau d'options

  • url_fermer (string) : ajoute un bouton ajax de fermeture
  • ajaxreload (array|string) : identifiants de blocs ajax à recharger.
  • ajaxreload_params (array) : paramètres à transmettre aux blocs rechargés.
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 $redirection = '' ], int $lier_trad[, array<string|int, mixed> $options = [] ]) : 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.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int

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

$options : array<string|int, mixed> = []

Tableau d'options

  • url_fermer (string) : ajoute un bouton ajax de fermeture
  • ajaxreload (array|string) : identifiants de blocs ajax à recharger.
  • ajaxreload_params (array) : paramètres à transmettre aux blocs rechargés.
Tags
uses
formulaires_editer_album_traiter()
uses
formulaires_joindre_document_traiter()
Return values
array<string|int, mixed>

Tableau de retours des traitements id_album, ids_documents, message_ok, message_erreur

js_ajouter_albums()

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

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

identifiants de blocs ajax à recharger

$params : array<string|int, mixed> = []
$ids : array<string|int, mixed> = []

identifiants des albums ajoutés

Return values
string

message js

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 = [] ][, 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> = []

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 = [] ][, 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> = []

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 = [] ][, 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> = []

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 = [] ][, 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> = []

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

Vérifier les albums insérés dans le texte d'un objet et mettre à jour les liens.

inc_marquer_doublons_albums_dist(mixed $champs, mixed $id, mixed $type, mixed $id_table_objet, mixed $table_objet, mixed $table_objet_sql[, mixed $desc = [] ][, mixed $serveur = '' ]) : array<string|int, mixed>

Utiliser charger_fonction('objet_marquer_albums_inseres', 'inc') à la place.

Parameters
$champs : mixed
$id : mixed
$type : mixed
$id_table_objet : mixed
$table_objet : mixed
$table_objet_sql : mixed
$desc : mixed = []
$serveur : mixed = ''
Tags
deprecated
uses
inc_objet_marquer_albums_inseres
Return values
array<string|int, mixed>

inc_objet_marquer_albums_inseres_dist()

Vérifier les albums insérés dans le texte d'un objet et mettre à jour les liens.

inc_objet_marquer_albums_inseres_dist(string $objet, int $id_objet, array<string|int, mixed> $data[, string $serveur = '' ]) : array<string|int, mixed>

On cherche les occurences des raccourcis des modèles d'albums <albumxx> dans une liste de champs prédéfinie, et on met à jour le champ vu des albums liés en fonction.

On reprend la liste du plugin médias qui cherche dans chapo et texte par défaut. Liste extensible en complétant $GLOBALS['medias_liste_champs'].

Parameters
$objet : string

Type d'objet

$id_objet : int

Identifiant de l'objet

$data : array<string|int, mixed>

Liste complète ou partielle des couples champ => valeur de l'objet En cas de liste partielle, les couples manquants sont récupérés automatiquement

$serveur : string = ''

Nom du connecteur

Return values
array<string|int, mixed>

Liste d'ids des albums insérés dans le texte

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

balise_ALBUM_DOC_dist()

Compile la balise `#ALBUM_DOC` qui retourne le code HTML d'un modèle de document ajusté pour les albums.

balise_ALBUM_DOC_dist(object $p) : object

Utilise en général un modèle standard sur lequel on ajoute des attributs et effectue des traitements sur les images.

Le choix du modèle et les traitements dépendent de la disposition de l'album et du contexte.

S'utilise uniquement dans une boucle documents imbriquée dans une boucle album.

Parameters
$p : object

Pile au niveau de la balise

Tags
uses
calculer_album_doc()
uses
calculer_album_params()
balise
example
#ALBUM_DOC
Return values
object

Pile complétée par le code à générer

calculer_album_doc()

Fonction privée pour calculer le HTML de la balise #ALBUM_DOC

calculer_album_doc(array<string|int, mixed> $document, array<string|int, mixed> $album) : string
Parameters
$document : array<string|int, mixed>

Tableau d'infos sur le document array<int id_document, string media, int largeur, int hauteur>

$album : array<string|int, mixed>

Tableau d'infos sur l'album et ses paramètres array<int id_album, …>

Tags
see
calculer_album_params()
Return values
string

balise_ALBUM_PARAMS_dist()

Compile la balise `#ALBUM_PARAMS` qui retourne soit un ensemble de valeurs utiles au modèle album, soit une seule.

balise_ALBUM_PARAMS_dist(object $p) : object

S'utilise dans une boucle album, ou dans une boucle documents imbriquée dans une boucle album.

Parameters
$p : object

Pile au niveau de la balise

Tags
uses
calculer_album_params()
balise
example
ALBUM_PARAMS
ALBUM_PARAMS{disposition}
Return values
object

Pile complétée par le code à générer

calculer_album_params()

Fonction privée pour calculer la balise `#ALBUM_PARAMS`

calculer_album_params(int $id_album[, array<string|int, mixed> $contexte = [] ][, string|null $param = null ]) : array<string|int, mixed>|string

En fonction du contexte, de la config et des défauts, on choisit la disposition, le modèle pour les documents, les valeurs pour les traitements à appliquer aux images, etc.

Chaque disposition a ses propres traitements d'image et options par défaut.

Parameters
$id_album : int

Numéro de l'album

$contexte : array<string|int, mixed> = []

Environnement du modèle

$param : string|null = null
Tags
uses
albums_decrire_dispositions()
Return values
array<string|int, mixed>|string

Soit un tableau de params : array<string disposition, string modele_doc, string_recadrer_ratio, int recadrer_sens, int largeur, int hauteur, bool images> Soit une la valeur d'un param

albums_classe_ratio()

Renvoie une classe correspondant à un ratio

albums_classe_ratio(string $ratio) : string

On arrondit à l'entier le plus proche, ex. : 2.21:12:12

Parameters
$ratio : string

Ratio sous la forme 1:1

Return values
string

format-square, format-landscape_2, format-portrait_3, etc.

filtre_inserer_attributs_album()

Ajoute les attributs nécessaires à une boîte album dans le privé

filtre_inserer_attributs_album(string $texte, string $id_album) : string

Rustine car |inserer_attribut ne fonctionne pas dans tous les cas

Parameters
$texte : string
$id_album : string
Return values
string

Search results