action_acceder_document_dist()

action_ajouter_documents_dist()

Ajouter des documents

Parameters

$id_document : int

Document à remplacer, ou pour une vignette, l'id_document de maman 0 ou 'new' pour une insertion

$files : array<string|int, mixed>

Tableau de tableaux de propriétés pour chaque document à insérer

$objet : string

Objet auquel associer le document

$id_objet : int

id_objet

$mode : string

Mode par défaut si pas precisé pour le document

action_ajouter_un_document_dist()

Ajouter un document (au format $_FILES)

Parameters

$id_document : int

Document à remplacer, ou pour une vignette, l'id_document de maman 0 ou 'new' pour une insertion

$file : array<string|int, mixed>

Propriétes au format $_FILE étendu :

• string tmp_name : source sur le serveur
• string name : nom du fichier envoye
• bool titrer : donner ou non un titre a partir du nom du fichier
• bool distant : pour utiliser une source distante sur internet
• string mode : vignette|image|documents|choix

$objet : string

Objet auquel associer le document

$id_objet : int

id_objet

$mode : string

Mode par défaut si pas precisé pour le document

determiner_sous_dossier_document()

Sous-repertoire dans lequel on stocke le document en regle general $ext/ sauf pour les logo

Parameters

$ext : mixed

$fichier : mixed

$mode : mixed

verifier_upload_autorise()

Vérifie la possibilité d'uploader une extension

Parameters

$source : string

Nom du fichier

$mode : string = ''

Mode d'inclusion du fichier, si connu

fixer_fichier_upload()

Tester le type de document

Parameters

$file : array<string|int, mixed>

Au format $_FILES

$mode : string = ''

Mode d'inclusion du fichier, si connu

verifier_taille_document_acceptable()

Verifier si le fichier respecte les contraintes de tailles

Parameters

$infos : array<string|int, mixed>

action_changer_mode_document_dist()

Cette action permet de basculer du mode image au mode document et vice versa

Parameters

$id_document : int = null

$mode : string = null

action_changer_mode_document_post()

Parameters

$id_document : mixed

$mode : mixed

action_copier_local_dist()

Fonction appellee lorsque l'utilisateur clique sur le bouton 'copier en local' (document/portfolio).

Parameters

$id_document : null = null

action_copier_local_post()

Parameters

$id_document : mixed

action_desordonner_liens_documents_dist()

Désordonner des documents

Parameters

$arg : string = null

fournit les arguments de la fonction dissocier_document sous la forme $id_objet-$objet-$document-suppr-safe

• 4eme arg : suppr = true, false sinon
• 5eme arg : safe = true, false sinon

desordonner_liens_documents()

Désordonner des documents

Parameters

$document : int|string

id_document a désordonner I/image pour dissocier les images en mode Image I/document pour dissocier les images en mode document D/document pour dissocier les documents non image en mode document

$objet : string

objet duquel dissocier

$id_objet : mixed

id_objet duquel dissocier

desordonner_liens_document()

Désordonner un document

Parameters

$id_document : int

id_document a désordonner

$objet : string

objet duquel dissocier

$id_objet : mixed

id_objet duquel dissocier

action_dissocier_document_dist()

Dissocier un document

Parameters

$arg : string = null

fournit les arguments de la fonction dissocier_document sous la forme $id_objet-$objet-$document-suppr-safe

• 4eme arg : suppr = true, false sinon
• 5eme arg : safe = true, false sinon

supprimer_lien_document()

Supprimer un lien entre un document et un objet

Parameters

$id_document : int

$objet : string

$id_objet : int

$supprime : bool = false

si true, le document est supprime si plus lie a aucun objet

$check : bool = false

si true, on verifie les documents references dans le texte de l'objet et on les associe si pas deja fait

dissocier_document()

Dissocier un ou des documents

Parameters

$document : int|string

id_document a dissocier I/image pour dissocier les images en mode Image I/document pour dissocier les images en mode document D/document pour dissocier les documents non image en mode document

$objet : string

objet duquel dissocier

$id_objet : mixed

id_objet duquel dissocier

$supprime : bool = false

supprimer les documents orphelins apres dissociation

$check : bool = false

verifier le texte des documents et relier les documents references dans l'objet

action_editer_document_dist()

Action editer_document

Parameters

$arg : int = null

document_inserer()

Creer un nouveau document

Parameters

$id_parent : int = null

inutilise, pas de parent pour les documents

$set : array<string|int, mixed>|null = null

document_modifier()

Enregistre une revision de document.

Parameters

$id_document : int

$set : array<string|int, mixed>|null = null

document_instituer()

determiner le statut d'un document : prepa/publie si on trouve un element joint sans champ statut ou avec un statut='publie' alors le doc est publie aussi

Parameters

$id_document : int

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

medias_revision_document_parents()

Revision des parents d'un document chaque parent est liste au format objet|id_objet

Parameters

$id_document : int

$parents : array<string|int, mixed> = null

$ajout : bool = false

logo_supprimer()

Supprimer le logo d'un objet

Parameters

$objet : string

$id_objet : int

$etat : string

on ou off

logo_modifier()

Modifier le logo d'un objet

Parameters

$objet : string

$id_objet : int

$etat : string

on ou off

$source : string|array<string|int, mixed>

• array : sous tableau de $_FILE issu de l'upload
• string : fichier source (chemin complet ou chemin relatif a tmp/upload)

action_ordonner_liens_documents_dist()

action_ordonner_liens_dist()

envoyer_json_envoi()

Parameters

$data : mixed

envoyer_json_erreur()

Parameters

$msg : mixed

action_supprimer_document_dist()

Parameters

$id_document : mixed = 0

action_supprimer_tous_orphelins()

action_tourner_dist()

Tourner un document

Parameters

$id_document : int = null

$angle : int = null

angle de rotation en degre>0

action_tourner_post()

Tourner un document

Parameters

$id_document : int

$angle : int

angle de rotation en degre>0

action_verifier_documents_brises_dist()

Verifier tous les fichiers brises

action_verifier_documents_liens_dist()

Vérifier tous les fichiers brisés

Parameters

$id_document : int|null = null

Indique le document cible de l'action, sinon il sera obtenu par la clé d'action sécurisée.

balise_ID_LOGO__dist()

Compile la balise dynamique `#ID_LOGO_xx` qui retourne l'identifiant du document utilisé comme logo pour un objet éditorial de SPIP.

Parameters

$p : Champ

Pile au niveau de la balise

Tags

balise

uses

generer_code_logo()

example

#ID_LOGO_ARTICLE

generer_code_logo()

Calcule le code HTML pour l'image ou l'information sur un logo

Parameters

$id_objet : string

Nom de la clé primaire de l'objet (id_article, ...)

$_id_objet : string

Code pour la compilation permettant de récupérer la valeur de l'identifiant

$type : string

Type d'objet

$align : string

Alignement demandé du logo

$_lien : mixed

$p : Champ

Pile au niveau de la balise

$suite : string

Suite éventuelle de la balise logo, telle que _SURVOL, _NORMAL ou _RUBRIQUE.

$champ : string = ''

Indique un type de champ à retourner (fichier, src, titre, descriptif, credits, id, alt)

Tags

uses

quete_logo()

uses

quete_html_logo()

used-by

balise_ID_LOGO__dist()

used-by

balise_LOGO__dist()

balise_LOGO__dist()

Compile la balise dynamique `#LOGO_xx` qui retourne le code HTML pour afficher l'image de logo d'un objet éditorial de SPIP.

Parameters

$p : Champ

Pile au niveau de la balise

Tags

balise

uses

generer_code_logo()

example

#LOGO_ARTICLE

medias_declarer_tables_interfaces()

Interfaces des tables documents pour le compilateur

Parameters

$interfaces : array<string|int, mixed>

medias_declarer_tables_principales()

Table principale spip_documents et spip_types_documents

Parameters

$tables_principales : array<string|int, mixed>

medias_declarer_tables_auxiliaires()

Table des liens documents-objets spip_documents_liens

Parameters

$tables_auxiliaires : array<string|int, mixed>

medias_declarer_tables_objets_surnoms()

Declarer le surnom des breves

Parameters

$surnoms : array<string|int, mixed>

medias_declarer_tables_objets_sql()

Parameters

$tables : mixed

creer_base_types_doc()

Creer la table des types de document

Parameters

$serveur : string = ''

$champ_media : string = 'media_defaut'

medias_optimiser_base_disparus()

Optimiser la base de données en supprimant les liens orphelins

Parameters

$flux : array<string|int, mixed>

formulaires_configurer_documents_charger_dist()

Chargement du formulaire de configuration des documents

formulaires_configurer_documents_traiter_dist()

Traitement du formulaire de configuration des documents

formulaires_editer_document_charger_dist()

Parameters

$id_document : mixed = 'new'

$id_parent : mixed = ''

$retour : mixed = ''

$lier_trad : mixed = 0

$config_fonc : mixed = 'documents_edit_config'

$row : mixed = []

$hidden : mixed = ''

documents_edit_config()

Parameters

$row : mixed

formulaires_editer_document_verifier_dist()

Parameters

$id_document : mixed = 'new'

$id_parent : mixed = ''

$retour : mixed = ''

$lier_trad : mixed = 0

$config_fonc : mixed = 'documents_edit_config'

$row : mixed = []

$hidden : mixed = ''

formulaires_editer_document_traiter_dist()

Parameters

$id_document : mixed = 'new'

$id_parent : mixed = ''

$retour : mixed = ''

$lier_trad : mixed = 0

$config_fonc : mixed = 'documents_edit_config'

$row : mixed = []

$hidden : mixed = ''

formulaires_illustrer_document_charger_dist()

Parameters

$id_document : mixed

formulaires_illustrer_document_verifier_dist()

Parameters

$id_document : mixed

formulaires_illustrer_document_traiter_dist()

Parameters

$id_document : mixed

joindre_determiner_mode()

Déterminer le mode d'upload si la valeur au chargement du formulaire est "auto"

Parameters

$mode : string

Le mode passé au formulaire

$id_document : int|string

L'identifiant numérique du document à remplacer ou "new" par défaut

$objet : string

Le type d'objet sur lequel ajouter le document

formulaires_joindre_document_charger_dist()

Chargement du formulaire

Parameters

$id_document : int|string = 'new'

L'identidiant numérique du document s'il est à remplacer, sinon "new"

$id_objet : int = 0

L'identifiant numérique de l'objet sur lequel on ajoute le document

$objet : string = ''

Le type de l'objet sur lequel on ajoute le document

$mode : string = 'auto'

Le mode du document (auto,choix,document,image,vignette...), par défaut auto

$galerie : string = false

Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')

$proposer_media : bool|string = true

Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.

$proposer_ftp : bool|string = true

Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.

formulaires_joindre_document_verifier_dist()

Vérification du formulaire

Parameters

$id_document : int|string = 'new'

L'identidiant numérique du document s'il est à remplacer, sinon "new"

$id_objet : int = 0

L'identifiant numérique de l'objet sur lequel on ajoute le document

$objet : string = ''

Le type de l'objet sur lequel on ajoute le document

$mode : string = 'auto'

Le mode du document (auto,choix,document,image,vignette...), par défaut auto

$galerie : string = false

Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')

$proposer_media : bool|string = true

Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.

$proposer_ftp : bool|string = true

Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.

formulaires_joindre_document_traiter_dist()

Traitement du formulaire

Parameters

$id_document : int|string = 'new'

L'identidiant numérique du document s'il est à remplacer, sinon "new"

$id_objet : int = 0

L'identifiant numérique de l'objet sur lequel on ajoute le document

$objet : string = ''

Le type de l'objet sur lequel on ajoute le document

$mode : string = 'auto'

Le mode du document (auto,choix,document,image,vignette...), par défaut auto

$galerie : string = false

Deprecated 4.0 (SPIP 4.1) Passer optionnellement une galerie jointe au form, plus utilise nativement, on prefere la mise a jour apres upload par ajaxReload('documents')

$proposer_media : bool|string = true

Doit on afficher la médiathèque ? par défaut oui Valeurs possibles si string : false,'non','no'.

$proposer_ftp : bool|string = true

Doit on afficher le ftp ? par défaut oui Valeurs possibles si string : false,'non','no'.

joindre_options_upload_ftp()

Retourner le contenu du select HTML d'utilisation de fichiers envoyes par le serveur

Parameters

$dir : string

Le répertoire de recherche des documents

$mode : string = 'document'

Le mode d'ajout de document

joindre_liste_contenu_tailles_archive()

Lister les fichiers contenus dans un zip

Parameters

$files : array<string|int, mixed>

La liste des fichiers

joindre_liste_erreurs_to_li()

Lister les erreurs dans une archive jointe Utilisé formulaires/inc-lister_archive_jointe.html

Parameters

$erreurs : array<string|int, mixed>

La liste des erreurs

genie_medias_nettoyer_repertoire_upload_dist()

Enlève les fichiers trop vieux du répertoire tmp/upload

Parameters

$last : int

inc_calculer_mime_type_application_mp4_dist()

Parameters

$id_document : int

$extension : string

$mime_type : string

inc_chercher_logo_dist()

Cherche le logo d'un élément d'objet

Parameters

$id : int

Identifiant de l'objet

$_id_objet : string

Nom de la clé primaire de l'objet

$mode : string = 'on'

Mode de survol du logo désiré (on ou off)

$compat_old_logos : bool = false

(unused) @deprecated 5.0

inc_choisir_mode_document()

Choisir le mode du document : image/document

Parameters

$infos : array<string|int, mixed>

Informations sur le document (en base + prises sur le fichier)

$type_inclus_image : bool

Type d'inclusion demandée : true si image

$objet : string

Objet sur lequel est placé le document

inc_determiner_statut_document()

Determiner le statut automatique d'un document

Parameters

$id_document : int

$statut_ancien : string

$date_publication_ancienne : string

inc_documenter_objet_dist()

Retourne le code HTML du portfolio, liste des documents et formulaire d'ajout de documents

Parameters

$id : int

Identifiant de l'objet

$type : string

Type d'objet

Tags

note

Marque les documents vus dans les textes de l'objet avant le calcul !

uses

inc_marquer_doublons_doc_dist()

set_spip_doc()

Donne le chemin du fichier relatif à `_DIR_IMG` pour stockage 'tel quel' dans la base de données

Parameters

$fichier : string|null

Tags

uses

_DIR_IMG

get_spip_doc()

Donne le chemin complet du fichier

Parameters

$fichier : string|null

Tags

uses

_DIR_IMG

copier_document()

Copier un document `$source` dans un dossier `IMG/$ext/$orig.$ext` ou `IMG/$subdir/$orig.$ext` si `$subdir` est fourni en numérotant éventuellement si un fichier de même nom existe déjà

Parameters

$ext : string

$orig : string

$source : string

$subdir : string = null

effacer_repertoire_temporaire()

Efface le répertoire de manière récursive !

Parameters

$nom : string

contenu_document()

Parameters

$arg : mixed

$charset : mixed = ''

generer_url_document_dist()

Parameters

$id_document : mixed

$args : mixed = ''

$ancre : mixed = ''

vignette_automatique()

Parameters

$img : mixed

$doc : mixed

$lien : mixed

$x : mixed = 0

$y : mixed = 0

$align : mixed = ''

$class : mixed = null

$connect : mixed = null

image_du_document()

Trouve une image caractéristique d'un document.

Parameters

$document : array<string|int, mixed>

$connect : null|string = null

affiche_raccourci_doc()

Affiche le code d'un raccourcis de document, tel que <doc123|left>

Parameters

$doc : string

Type de raccourcis : doc,img,emb...

$id : int

Identifiant du document

$align : string = ''

Alignement du document : left,center,right

$short : bool = false

Réduire le texte affiché à la valeur de 'align'

erreur_upload_trop_gros()

Traite l'erreur d'un upload trop gros

Tags

see

minipres()

used-by

medias_detecter_fond_par_defaut()

joindre_trouver_fichier_envoye()

Recuperer le nom du fichier selon le mode d'upload choisi et mettre cela au format $_FILES

joindre_trouver_http_post_files()

Récupérer et mettre en forme la liste des fichiers postes que ce soit via plusieurs input file ou via un input file multiple

Parameters

$name : mixed = null

: nom de l'input qu'on veut recuperer si on ne veut pas tous les fichiers

joindre_upload_error()

Parameters

$error : mixed

joindre_verifier_zip()

Verifier si le fichier poste est un zip Si on sait le deballer, proposer les options necessaires

Parameters

$files : array<string|int, mixed>

joindre_decrire_contenu_zip()

Verifier et decrire les fichiers de l'archive, en deux listes : - une liste des noms de fichiers ajoutables - une liste des erreurs (fichiers refuses)

Parameters

$infos : mixed

joindre_deballer_lister_zip()

Parameters

$path : mixed

$tmp_dir : mixed

fixer_extension_document()

Cherche dans la base le type-mime du tableau representant le document et corrige le nom du fichier ; retourne array(extension, nom corrige) s'il ne trouve pas, retourne '' et le nom inchange

Parameters

$doc : array{name: string, type: string}

accepte_fichier_upload()

Gestion des fichiers ZIP

Parameters

$f : string

inc_marquer_doublons_doc_dist()

Trouver les documents utilisés dans le texte d'un objet et enregistrer cette liaison comme vue.

Parameters

$champs : array<string|int, mixed>

Couples [champ => valeur] connus de l'objet

$id : int

Identifiant de l'objet

$type : string

Type d'objet éditorial (ex: article)

$id_table_objet : string

Nom de la clé primaire sur la table sql de l'objet

$table_objet : string

Nom de l'objet éditorial (ex: articles)

$spip_table_objet : string

Nom de la table sql de l'objet

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

Description de l'objet, si déjà calculé

$serveur : string = ''

Serveur sql utilisé.

Tags

note

La fonction pourrait avoir bien moins d'arguments : seuls $champs, $id, $type ou $objet, $desc, $serveur sont nécessaires. On calcule $desc s'il est absent, et il contient toutes les infos…

used-by

inc_documenter_objet_dist()

renseigner_source_distante()

Récuperer les infos distantes d'une URL, et renseigner pour une insertion en base

Parameters

$source : string

URL du document

$callback_valider_url : mixed = ''

Tags

pipeline_appel

renseigner_document_distant

renseigner_taille_dimension_image()

Renseigner les informations de taille et dimension d'un document

Parameters

$fichier : string

Le fichier à examiner

$ext : string

L'extension du fichier à examiner

$distant : bool = false

Indique que le fichier peut etre distant, on essaiera alors d'en recuperer un bout pour en lire les meta infos

Tags

todo

Renommer cette fonction sans "_image"

sanitizer_document()

Parameters

$fichier : string

$ext : string

inc_verifier_document_mode_image_dist()

Parameters

$infos : mixed

inc_verifier_document_mode_vignette_dist()

Parameters

$infos : mixed

inc_verifier_taille_document_acceptable_dist()

Verifier si le fichier respecte les contraintes de tailles

Parameters

$infos : array<string|int, mixed>

$is_logo : bool = false

medias_verifier_largeur_hauteur_image()

Verifier largeur maxi et hauteur maxi d'une image + largeur mini et hauteur mini

Parameters

$infos : array<string|int, mixed>

$max_width : null|int = null

$max_height : null|int = null

$min_width : null|int = null

$min_height : null|int = null

medias_verifier_poids_fichier()

verifier le poids maxi d'une image

Parameters

$infos : array<string|int, mixed>

$max_size : null|int = null

$is_image : mixed = false

inc_vignette_dist()

Vignette pour une extension de document

Parameters

$ext : string

Extension du fichier. Exemple : png

$media : string = ''

Permet de retourner une variante de la vignette adaptee au media cas des mp4 par exemple que l'on decline quand c'est un audio

$loop : bool = true

Autoriser la fonction à s'appeler sur elle-même (paramètre interne).

medias_check_statuts()

verifier et maj le statut des documents

Parameters

$affiche : bool = false

medias_upgrade()

Mise a jour de la BDD

Parameters

$nom_meta_base_version : string

$version_cible : string

medias_upgrade_images_exif_orientation_menage()

Nettoyer la meta mise en place lors de la migratiopn des dimensions des images en mode portrait porteuses d'un EXIF d'orientation

medias_upgrade_images_exif_orientation()

Gérer la migration des hauteur et largeur des images en mode portrait porteuses d'un EXIF d'orientation

medias_upgrade_logo_objet()

Upgrader les logos objet vers des documents

Parameters

$objet : mixed

medias_maj_meta_documents()

Maj des meta documents

medias_peuple_media_document()

Parameters

$champ_media : mixed = 'media_defaut'

medias_maj_date_publication_documents()

Maj des date de publication des documents cf ticket #3329, z104221

medias_autoriser()

Fonction d'appel pour le pipeline

Tags

pipeline

autoriser

autoriser_documents_voir_dist()

Autorisation de voir la page documents

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_documents_menu_dist()

Autorisation de voir le bouton Documents dans le menu

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_document_tailler_dist()

Autoriser le changement des dimensions sur un document

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

autoriser_joindredocument_dist()

Autorisation de joindre un document

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_document_modifier_dist()

Autorisation de modifier un document

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

$opt : array<string|int, mixed>

Options de cette autorisation

Tags

staticvar

$m

autoriser_document_supprimer_dist()

Autorisation de supprimer un document

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_document_voir_dist()

Autorisation de voir un document

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

$opt : array<string|int, mixed>

Options de cette autorisation bool $htaccess : true pour tester l'autorisation de voir via le htaccess

Tags

todo

À revoir car c'est dommage de sortir de l'API true/false

autoriser_autoassocierdocument_dist()

Autorisation d'auto-association de documents à du contenu editorial qui le référence

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_orphelins_supprimer_dist()

Autoriser à nettoyer les orphelins de la base des documents

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

$opt : array<string|int, mixed>

Options de cette autorisation

autoriser_associerdocuments_dist()

Autoriser a associer des documents a un objet : il faut avoir le droit de modifier cet objet

Parameters

$faire : mixed

$type : mixed

$id : mixed

$qui : mixed

$opt : mixed

autoriser_dissocierdocuments_dist()

Autoriser a dissocier des documents a un objet : il faut avoir le droit de modifier cet objet

Parameters

$faire : mixed

$type : mixed

$id : mixed

$qui : mixed

$opt : mixed

medias_modeles_styliser()

Styliser le modele media : reroute les <img> <doc> <emb> vers <image>, <audio>, <video>, <file> selon le media du document si le document n'est pas trouve c'est <file> qui s'applique

Parameters

$modele : mixed

$id : mixed

medias_inigetoctets()

Retourne la taille en octet d'une valeur de configuration php

Parameters

$var : string

Clé de configuration ; valeur récupérée par ini_get(). Exemple post_max_size

medias_puce_statut_document()

Afficher la puce de statut pour les documents

Parameters

$id_document : int

Identifiant du document

$statut : string

Statut du document

boucle_DOCUMENTS()

Compile la boucle `DOCUMENTS` qui retourne une liste de documents multimédia

Parameters

$id_boucle : string

Identifiant de la boucle

$boucles : array<string|int, mixed>

AST du squelette

critere_DOCUMENTS_orphelins_dist()

critere {orphelins} selectionne les documents sans liens avec un objet editorial

Parameters

$idb : string

$boucles : object

$crit : object

critere_DOCUMENTS_portrait_dist()

critere {portrait} qui selectionne - les documents dont les dimensions sont connues - les documents dont la hauteur est superieure a la largeur

Parameters

$idb : string

$boucles : object

$crit : object

critere_DOCUMENTS_paysage_dist()

critere {paysage} qui selectionne - les documents dont les dimensions sont connues - les documents dont la hauteur est inferieure a la largeur

Parameters

$idb : string

$boucles : object

$crit : object

critere_DOCUMENTS_carre_dist()

critere {carre} qui selectionne - les documents dont les dimensions sont connues - les documents dont la hauteur est egale a la largeur

Parameters

$idb : string

$boucles : object

$crit : object

balise_MIME_TYPE_dist()

Balise `#MIME_TYPE`

Parameters

$p : Champ

medias_mime_type_document()

Parameters

$id_document : int

$extension : string = ''

filtre_titre_mime_type_dist()

Parameters

$id_document : int

$extension : string

filtre_vignette_dist()

Calcule la vignette d'une extension (l'image du type de fichier)

Parameters

$extension : string = 'defaut'

L'extension du fichier, exemple : png ou pdf

$get_chemin : bool = false

false pour obtenir une balise img de l'image, true pour obtenir seulement le chemin du fichier

Tags

example

[(#EXTENSION|vignette)] produit une balise <img ... /> [(#EXTENSION|vignette{true})] retourne le chemin de l'image

medias_lister_methodes_upload()

Determiner les methodes upload en fonction du env de inc-upload_document

Parameters

$env : string|array<string|int, mixed>

duree_en_secondes()

Parameters

$duree : mixed

$precis : mixed = false

medias_trouver_modele_emb()

Trouver le fond pour embarquer un document - avec une extension - avec un mime_type donne

Parameters

$extension : string

$mime_type : string

$modele_base : mixed = 'file'

media_determine_autolien()

Determiner si un media doit etre mis en autolien dans les modeles document Par defaut utilisé uniquement sur les media image, mais le filtre peut être surchargé pour étendre son fonctionnement

Parameters

$media : string

$extension : string

$largeur : int|null

$hauteur : int|null

$id_document : int|null = 0

filtre_medias_modele_document_standard_classes_dist()

Liste les classes standards des modèles de documents SPIP.

Parameters

$Pile : array<string|int, mixed>

$id_document : int

$media : string

Tags

note

le nomage au pluriel est historique. préférer au singulier pour toute nouvelle classe.

filtre_medias_modele_document_standard_attributs_dist()

Liste les attributs data standards des modèles de documents SPIP.

Parameters

$Pile : array<string|int, mixed>

$id_document : int

$media : string

medias_str_repeat_log()

Retourne une chaine répétée d'autant de fois le logarithme

Parameters

$num : float

$base : mixed = 2

$string : mixed = 'x'

$remove : int = 0

: Nombre de caractères à enlever.

Tags

example

medias_str_repeat_log(124, 2)

Avec $base = 2 et $remove = 0

0 => 2 => x 4 => xx 8 => xxx 16 => xxxx 32 => xxxxx 64 => xxxxxx

example

medias_str_repeat_log(124, 2, "x", 4)

Avec $base = 2 et $remove = 4

0 => 2 => 4 => 8 => 16 => 32 => x 64 => xx

note

L'inverse (nb caractères => valeur) est donc pow($base, $nb_char)

En partant du nombre de "x" on retrouve la fourchette du nombre de départ. Si $base = 2 et $remove = 4 :

• "xxx" = 2 ^ (strlen("xxx") + 4) = 2 ^ (3 + 4) = 128
• "xxxxx" = 2 ^ (5 + 4) = 512

x = 32, xx = 64 xxx = 128 xxxx = 256 xxxxx = 512 ...

Ce qui veut dire que "xxx" provient d'une valeur entre 128 et 255.

note

C'est surtout utile pour une sélection en CSS (car CSS ne permet pas de sélecteur "lower than" ou "greater than") :

<div class='demo' data-demo-lenx='[(#TEXTE|textebrut|spip_strlen|medias_str_repeat_log{2,x,4})]'>...</div>`

.demo[data-demo-lenx^="xxxx"] {
   // le contenu fait au moins 256 caractères
}
.demo:not([data-demo-lenx^="xxxx"]) {
   // le contenu fait au moins 256 caractères
}

balise_URL_DOCUMENT_FICHIER_dist()

Parameters

$p : mixed

medias_ieconfig_metas()

Parameters

$table : mixed

medias_detecter_fond_par_defaut()

Traiter le cas pathologique d'un upload de document ayant echoué car étant trop gros

Parameters

$fond : string

Nom du squelette par défaut qui sera utilisé

Tags

uses

erreur_upload_trop_gros()

pipeline

detecter_fond_par_defaut

medias_post_insertion()

À chaque insertion d'un nouvel objet editorial auquel on a attaché des documents, restituer l'identifiant du nouvel objet crée sur les liaisons documents/objet, qui ont ponctuellement un identifiant id_objet négatif.

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

see

medias_affiche_gauche()

pipeline

post_insertion

medias_affiche_milieu()

Ajoute la configuration des documents à la page de configuration des contenus

Parameters

$flux : array<string|int, mixed>

Tags

pipeline

affiche_milieu

medias_configurer_liste_metas()

Définir les meta de configuration liées aux documents

Parameters

$config : array<string|int, mixed>

Couples nom de la méta => valeur par défaut

Tags

pipeline

configurer_liste_metas

medias_pre_edition()

Compléter un début de traduction avec le logo de l’objet que l’on traduit

Parameters

$flux : array<string|int, mixed>

Tags

pipeline

pre_edition

medias_post_edition()

Institue ou met à jour les liens de documents après l'édition d'un objet

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

pipeline

post_edition

medias_afficher_complement_objet()

Ajouter le portfolio et ajout de document sur les fiches objet

Parameters

$flux : array<string|int, mixed>

Tags

pipeline

afficher_complement_objet

medias_affiche_gauche()

Ajoute le formulaire d'ajout de document au formulaire d'édition d'un objet (lorsque cet objet peut recevoir des documents).

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

note

HACK : Lors d'une première création de l'objet, celui-ci n'ayant pas encore d'identifiant tant que le formulaire d'édition n'est pas enregistré, les liaisions entre les documents liés et l'objet à créer sauvegardent un identifiant d'objet négatif de la valeur de id_auteur (l'auteur connecte). Ces liaisons seront corrigées après validation dans le pipeline medias_post_insertion()

pipeline

affiche_gauche

see

medias_post_insertion()

medias_document_desc_actions()

Utilisation du pipeline document_desc_actions

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

pipeline

document_desc_actions

medias_editer_document_actions()

Utilisation du pipeline editer_document_actions

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

pipeline

editer_document_actions

medias_renseigner_document_distant()

Utilisation du pipeline renseigner_document_distant

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

see

renseigner_source_distante()

pipeline

renseigner_document_distant

medias_objet_compte_enfants()

Compter les documents dans un objet

Parameters

$flux : array<string|int, mixed>

Tags

pipeline

objet_compte_enfants

medias_boite_infos()

Afficher le nombre de documents dans chaque rubrique

Parameters

$flux : array<string|int, mixed>

Tags

pipeline

boite_infos

medias_revisions_chercher_label()

Insertion dans le pipeline revisions_chercher_label (Plugin révisions) Trouver le bon label à afficher sur les champs dans les listes de révisions

Parameters

$flux : array<string|int, mixed>

Données du pipeline

Tags

pipeline

revisions_chercher_label

medias_calculer_rubriques()

Publier une rubrique ayant un document joint…

Parameters

$flux : array<string|int, mixed>

metadata_audio()

Fonction de récupération des métadonnées sur les fichiers audio appelée à l'insertion en base dans le plugin medias (inc/renseigner_document)

Parameters

$file : string

Le chemin du fichier à analyser

medata_html_dist()

enlever les scripts de html si necessaire on utilise safehtml

Parameters

$file : string

metadata_image_dist()

Parameters

$fichier : mixed

decoder_type_image()

Convertit le type numerique retourne par getimagesize() en extension fichier

Parameters

$type : int

$strict : bool = false

metadata_mp4_dist()

Parameters

$file : mixed

metadata_swf_dist()

Parameters

$file : mixed

metadata_video()

Fonction de récupération des métadonnées sur les fichiers vidéo appelée à l'insertion en base dans le plugin medias (inc/renseigner_document)

Parameters

$file : string

Le chemin du fichier à analyser

medias_raccourcis_doc()

Parameters

$id_document : mixed

$titre : mixed

$descriptif : mixed

$inclus : mixed

$largeur : mixed

$hauteur : mixed

$mode : mixed

$vu : mixed

$media : mixed = null

medias_raccourcis_doc_groupe()

Parameters

$doc : mixed

$id_document : mixed

liste_extensions_utilisees()

Parameters

$media : mixed

quete_logo_objet()

Chercher le logo d'un contenu précis

Parameters

$id_objet : int

Idenfiant de l'objet dont on cherche le logo

$objet : string

Type de l'objet dont on cherche le logo

$mode : string

"on" ou "off" suivant le logo normal ou survol

quete_logo_file()

Retourne le logo d’un fichier (document spip) sinon la vignette du type du fichier

Parameters

$row : array<string|int, mixed>

$connect : string = null

quete_logo_document()

Trouver l'image logo d'un document

Parameters

$row : array<string|int, mixed>

description du document, issue de la base

$lien : mixed

url de lien

$align : mixed

alignement left/right

$mode_logo : mixed

mode du logo : '' => automatique (vignette sinon apercu sinon icone) icone => icone du type du fichier apercu => apercu de l'image exclusivement, meme si une vignette existe vignette => vignette exclusivement, ou rien si elle n'existe pas

$x : mixed

largeur maxi

$y : mixed

hauteur maxi

$connect : string = ''

serveur

quete_html_logo()

Recuperer le HTML du logo d'apres ses infos

Parameters

$logo : array<string|int, mixed>

$align : string

$lien : string