Documentation du code de SPIP et de ses plugins

Albums

ajouter_album.php

Gestion du formulaire d'ajout d'album

Le formulaire permet soit de créer et remplir un nouvel album, soit de choisir des albums existants. Il s'agit en gros d'une fusion des formulaires editer_album, joindre_document et editer_liens.

Tags
plugin

Albums

copyright

2014

author

Tetue, Charles Razack

licence

GNU/GPL

Table of Contents

Functions

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

Functions

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

type d'un objet à associer (optionnel).

$id_objet : int|string = 0

Identifiant d'un objet à associer (optionnel).

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

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 = 0 ][, string $redirection = '' ][, int $lier_trad = 0 ][, 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 = 0

Identifiant de l'objet à associer.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

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 = 0 ][, string $redirection = '' ][, int $lier_trad = 0 ][, 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 = 0

Identifiant de l'objet à associer.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

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 = 0 ][, string $redirection = '' ][, int $lier_trad = 0 ][, 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 = 0

Identifiant de l'objet à associer.

$redirection : string = ''

URL de redirection après le traitement

$lier_trad : int = 0

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


        
On this page

Search results