SPIP Code

Documentation du code de SPIP et de ses plugins

Albums

Formulaires

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

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

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

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

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

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

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> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results