SPIP Code

Documentation du code de SPIP et de ses plugins

Albums

Action

Table of Contents

Functions

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

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

desordonner_liens_albums()

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

desordonner_liens_albums(string $objet, string $objet_lie, mixed $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 : mixed

Numéro de l'objet duquel dissocier

$champ_rang : string|null

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}

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

ordonner_liens_albums_json_erreur()

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

action_supprimer_album_dist()

Supprime un album proprement

action_supprimer_album_dist([mixed $arg = null ]) : void
Parameters
$arg : mixed = 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()

action_vider_album_dist()

«Vider» un album : dissocier tous ses documents

action_vider_album_dist([mixed $arg = null ]) : void

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

Parameters
$arg : mixed = 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() 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results