Documentation du code de SPIP et de ses plugins

Medias

Application

Table of Contents

Constants

_BOUTON_MODE_IMAGE  = \true
_TITRER_DOCUMENTS  = false
CHARSET_JOINT  = 'iso-8859-1'

Functions

action_acceder_document_dist()  : mixed
action_ajouter_documents_dist()  : array<string|int, mixed>
Ajouter des documents
action_ajouter_un_document_dist()  : array<string|int, mixed>|bool|int|mixed|string|unknown
Ajouter un document (au format $_FILES)
determiner_sous_dossier_document()  : mixed
Sous-repertoire dans lequel on stocke le document en regle general $ext/ sauf pour les logo
verifier_upload_autorise()  : array<string|int, mixed>|bool|string
Vérifie la possibilité d'uploader une extension
fixer_fichier_upload()  : array<string|int, mixed>|string
Tester le type de document
verifier_taille_document_acceptable()  : bool|mixed|string
Verifier si le fichier respecte les contraintes de tailles
action_changer_mode_document_dist()  : void
Cette action permet de basculer du mode image au mode document et vice versa
action_changer_mode_document_post()  : mixed
action_copier_local_dist()  : bool|mixed|string
Fonction appellee lorsque l'utilisateur clique sur le bouton 'copier en local' (document/portfolio).
action_copier_local_post()  : bool|mixed|string
action_editer_document_dist()  : array<string|int, mixed>
Action editer_document
document_inserer()  : int
Creer un nouveau document
document_modifier()  : string|null
Enregistre une revision de document.
document_instituer()  : bool
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
medias_revision_document_parents()  : mixed
Revision des parents d'un document chaque parent est liste au format objet|id_objet
action_supprimer_document_dist()  : mixed
action_supprimer_tous_orphelins()  : mixed
action_tourner_dist()  : void
Tourner un document
action_tourner_post()  : mixed
Tourner un document
tourner_selon_exif_orientation()  : mixed
action_verifier_documents_brises_dist()  : mixed
Verifier tous les fichiers brises
formulaires_editer_document_charger_dist()  : mixed
documents_edit_config()  : mixed
formulaires_editer_document_verifier_dist()  : mixed
formulaires_editer_document_traiter_dist()  : mixed
formulaires_illustrer_document_charger_dist()  : mixed
formulaires_illustrer_document_verifier_dist()  : mixed
formulaires_illustrer_document_traiter_dist()  : mixed
contenu_document()  : mixed
generer_url_document_dist()  : mixed
vignette_automatique()  : mixed
image_du_document()  : string
Trouve une image caractéristique d'un document.
affiche_raccourci_doc()  : string
Affiche le code d'un raccourcis de document, tel que <doc123|left>
inc_verifier_document_mode_image_dist()  : mixed
inc_verifier_document_mode_vignette_dist()  : mixed
medias_check_statuts()  : mixed
verifier et maj le statut des documents
medias_upgrade()  : mixed
Mise a jour de la BDD
medias_upgrade_logo_objet()  : mixed
Upgrader les logos objet vers des documents
medias_maj_meta_documents()  : mixed
Maj des meta documents
medias_peuple_media_document()  : mixed
medias_maj_date_publication_documents()  : mixed
Maj des date de publication des documents cf ticket #3329, z104221
medias_ieconfig_metas()  : mixed
medata_html_dist()  : array<string|int, mixed>
enlever les scripts de html si necessaire on utilise safehtml
metadata_image_dist()  : mixed
decoder_type_image()  : string
Convertit le type numerique retourne par getimagesize() en extension fichier
metadata_swf_dist()  : mixed
affiche_bouton_mode_image_portfolio()  : mixed
medias_raccourcis_doc()  : mixed
medias_raccourcis_doc_groupe()  : string
liste_extensions_utilisees()  : mixed
puce_statut_document_dist()  : string
Afficher la puce statut d'un document : en fait juste une icone independante du statut
urls_generer_url_document_dist()  : string
Generer l'url d'un document dans l'espace public, fonction du statut du document
urls_generer_url_ecrire_document_dist()  : string
Generer l'url d'un document dans l'espace prive, fonction du statut du document

Constants

Functions

action_ajouter_documents_dist()

Ajouter des documents

action_ajouter_documents_dist(int $id_document, array<string|int, mixed> $files, string $objet, int $id_objet, string $mode) : array<string|int, mixed>
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

Return values
array<string|int, mixed>

Liste des id_documents inserés

action_ajouter_un_document_dist()

Ajouter un document (au format $_FILES)

action_ajouter_un_document_dist(int $id_document, array<string|int, mixed> $file, string $objet, int $id_objet, string $mode) : array<string|int, mixed>|bool|int|mixed|string|unknown
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

Return values
array<string|int, mixed>|bool|int|mixed|string|unknown
  • int : l'id_document ajouté (opération réussie)
  • string : une erreur s'est produit, la chaine est le message d'erreur

determiner_sous_dossier_document()

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

determiner_sous_dossier_document( $ext,  $fichier,  $mode) : mixed
Parameters
$ext :
$fichier :
$mode :

verifier_upload_autorise()

Vérifie la possibilité d'uploader une extension

verifier_upload_autorise(string $source[, string $mode = '' ]) : array<string|int, mixed>|bool|string

Vérifie aussi si l'extension est autorisée pour le mode demandé si on connait le mode à ce moment là

Parameters
$source : string

Nom du fichier

$mode : string = ''

Mode d'inclusion du fichier, si connu

Return values
array<string|int, mixed>|bool|string
  • array : extension acceptée (tableau descriptif). Avec un index 'autozip' si il faut zipper
  • false ou message d'erreur si l'extension est refusée

fixer_fichier_upload()

Tester le type de document

fixer_fichier_upload(array<string|int, mixed> $file[, string $mode = '' ]) : array<string|int, mixed>|string
  • le document existe et n'est pas de taille 0 ?
  • interdit a l'upload ?
  • quelle extension dans spip_types_documents ?
  • est-ce "inclus" comme une image ?

Le zipper si necessaire

Parameters
$file : array<string|int, mixed>

Au format $_FILES

$mode : string = ''

Mode d'inclusion du fichier, si connu

Return values
array<string|int, mixed>|string

verifier_taille_document_acceptable()

Verifier si le fichier respecte les contraintes de tailles

verifier_taille_document_acceptable(array<string|int, mixed> &$infos) : bool|mixed|string
Parameters
$infos : array<string|int, mixed>
Return values
bool|mixed|string

action_changer_mode_document_dist()

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

action_changer_mode_document_dist([int $id_document = null ][, string $mode = null ]) : void
Parameters
$id_document : int = null
$mode : string = null

action_changer_mode_document_post()

action_changer_mode_document_post(mixed $id_document, mixed $mode) : mixed
Parameters
$id_document : mixed
$mode : mixed

action_copier_local_dist()

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

action_copier_local_dist([null $id_document = null ]) : bool|mixed|string

Il s'agit de la partie logique, c'est a dire que cette fonction realise la copie.

Parameters
$id_document : null = null
Return values
bool|mixed|string

action_copier_local_post()

action_copier_local_post( $id_document) : bool|mixed|string
Parameters
$id_document :
Return values
bool|mixed|string

action_editer_document_dist()

Action editer_document

action_editer_document_dist([int $arg = null ]) : array<string|int, mixed>
Parameters
$arg : int = null
Return values
array<string|int, mixed>

document_inserer()

Creer un nouveau document

document_inserer([int $id_parent = null ][, array<string|int, mixed>|null $set = null ]) : int
Parameters
$id_parent : int = null

inutilise, pas de parent pour les documents

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

document_modifier()

Enregistre une revision de document.

document_modifier(int $id_document[, array<string|int, mixed>|null $set = null ]) : string|null

$set est un contenu (par defaut on prend le contenu via _request())

Parameters
$id_document : int
$set : array<string|int, mixed>|null = null
Return values
string|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

document_instituer(int $id_document[, array<string|int, mixed> $champs = [] ]) : bool
Parameters
$id_document : int
$champs : array<string|int, mixed> = []
Return values
bool

medias_revision_document_parents()

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

medias_revision_document_parents(int $id_document[, array<string|int, mixed> $parents = null ][, bool $ajout = false ]) : mixed
Parameters
$id_document : int
$parents : array<string|int, mixed> = null
$ajout : bool = false

action_supprimer_document_dist()

action_supprimer_document_dist([mixed $id_document = 0 ]) : mixed
Parameters
$id_document : mixed = 0

action_tourner_dist()

Tourner un document

action_tourner_dist([int $id_document = null ][, int $angle = null ]) : void

lorsque les arguments sont passes dans arg en GET : id_document-angle

Parameters
$id_document : int = null
$angle : int = null

angle de rotation en degre>0

action_tourner_post()

Tourner un document

action_tourner_post(int $id_document, int $angle) : mixed
Parameters
$id_document : int
$angle : int

angle de rotation en degre>0

tourner_selon_exif_orientation()

tourner_selon_exif_orientation(mixed $id_document, mixed $fichier) : mixed
Parameters
$id_document : mixed
$fichier : mixed

formulaires_editer_document_charger_dist()

formulaires_editer_document_charger_dist([mixed $id_document = 'new' ][, mixed $id_parent = '' ][, mixed $retour = '' ][, mixed $lier_trad = 0 ][, mixed $config_fonc = 'documents_edit_config' ][, mixed $row = [] ][, mixed $hidden = '' ]) : mixed
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()

documents_edit_config(mixed $row) : mixed
Parameters
$row : mixed

formulaires_editer_document_verifier_dist()

formulaires_editer_document_verifier_dist([mixed $id_document = 'new' ][, mixed $id_parent = '' ][, mixed $retour = '' ][, mixed $lier_trad = 0 ][, mixed $config_fonc = 'documents_edit_config' ][, mixed $row = [] ][, mixed $hidden = '' ]) : mixed
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()

formulaires_editer_document_traiter_dist([mixed $id_document = 'new' ][, mixed $id_parent = '' ][, mixed $retour = '' ][, mixed $lier_trad = 0 ][, mixed $config_fonc = 'documents_edit_config' ][, mixed $row = [] ][, mixed $hidden = '' ]) : mixed
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()

formulaires_illustrer_document_charger_dist(mixed $id_document) : mixed
Parameters
$id_document : mixed

formulaires_illustrer_document_verifier_dist()

formulaires_illustrer_document_verifier_dist(mixed $id_document) : mixed
Parameters
$id_document : mixed

formulaires_illustrer_document_traiter_dist()

formulaires_illustrer_document_traiter_dist(mixed $id_document) : mixed
Parameters
$id_document : mixed

contenu_document()

contenu_document(mixed $arg[, mixed $charset = '' ]) : mixed
Parameters
$arg : mixed
$charset : mixed = ''

generer_url_document_dist()

generer_url_document_dist(mixed $id_document[, mixed $args = '' ][, mixed $ancre = '' ]) : mixed
Parameters
$id_document : mixed
$args : mixed = ''
$ancre : mixed = ''

vignette_automatique()

vignette_automatique(mixed $img, mixed $doc, mixed $lien[, mixed $x = 0 ][, mixed $y = 0 ][, mixed $align = '' ][, mixed $class = null ][, mixed $connect = null ]) : mixed
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.

image_du_document(array<string|int, mixed> $document[, null|string $connect = null ]) : string

Si celui-ci est une image et que les outils graphiques sont dispos, retourner le document (en exploitant sa copie locale s'il est distant).

Si on a un connecteur externe, on utilise l’URL externe.

Autrement retourner la vignette fournie par SPIP pour ce type MIME

Parameters
$document : array<string|int, mixed>
$connect : null|string = null
Return values
string

Chemin de l’image

affiche_raccourci_doc()

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

affiche_raccourci_doc(string $doc, int $id[, string $align = '' ][, bool $short = false ]) : string

Affiche un code de raccourcis de document, et l'insère dans le textarea principal de l'objet (champ 'texte') sur un double-clic

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'

Return values
string

Texte du raccourcis

medias_check_statuts()

verifier et maj le statut des documents

medias_check_statuts([bool $affiche = false ]) : mixed
Parameters
$affiche : bool = false

medias_upgrade()

Mise a jour de la BDD

medias_upgrade(string $nom_meta_base_version, string $version_cible) : mixed
Parameters
$nom_meta_base_version : string
$version_cible : string

medias_upgrade_logo_objet()

Upgrader les logos objet vers des documents

medias_upgrade_logo_objet( $objet) : mixed
Parameters
$objet :

medias_peuple_media_document()

medias_peuple_media_document([mixed $champ_media = 'media_defaut' ]) : mixed
Parameters
$champ_media : mixed = 'media_defaut'

medias_maj_date_publication_documents()

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

medias_maj_date_publication_documents() : mixed

medias_ieconfig_metas()

medias_ieconfig_metas(mixed $table) : mixed
Parameters
$table : mixed

medata_html_dist()

enlever les scripts de html si necessaire on utilise safehtml

medata_html_dist(string $file) : array<string|int, mixed>
Parameters
$file : string
Return values
array<string|int, mixed>

metadata_image_dist()

metadata_image_dist(mixed $fichier) : mixed
Parameters
$fichier : mixed

decoder_type_image()

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

decoder_type_image(int $type[, bool $strict = false ]) : string
Parameters
$type : int
$strict : bool = false
Return values
string

metadata_swf_dist()

metadata_swf_dist(mixed $file) : mixed
Parameters
$file : mixed

affiche_bouton_mode_image_portfolio()

affiche_bouton_mode_image_portfolio(mixed $inclus) : mixed
Parameters
$inclus : mixed

medias_raccourcis_doc()

medias_raccourcis_doc(mixed $id_document, mixed $titre, mixed $descriptif, mixed $inclus, mixed $largeur, mixed $hauteur, mixed $mode, mixed $vu[, mixed $media = null ]) : mixed
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()

medias_raccourcis_doc_groupe(mixed $doc, mixed $id_document) : string
Parameters
$doc : mixed
$id_document : mixed
Return values
string

puce_statut_document_dist()

Afficher la puce statut d'un document : en fait juste une icone independante du statut

puce_statut_document_dist(int $id, string $statut, int $id_rubrique, string $type[, string $ajax = '' ]) : string
Parameters
$id : int
$statut : string
$id_rubrique : int
$type : string
$ajax : string = ''
Return values
string

urls_generer_url_document_dist()

Generer l'url d'un document dans l'espace public, fonction du statut du document

urls_generer_url_document_dist(int $id[, string $args = '' ][, string $ancre = '' ][, string $public = null ][, string $connect = '' ]) : string
Parameters
$id : int
$args : string = ''
$ancre : string = ''
$public : string = null
$connect : string = ''
Return values
string

urls_generer_url_ecrire_document_dist()

Generer l'url d'un document dans l'espace prive, fonction du statut du document

urls_generer_url_ecrire_document_dist(int $id[, string $args = '' ][, string $ancre = '' ][, string $public = null ][, string $connect = '' ]) : string
Parameters
$id : int
$args : string = ''
$ancre : string = ''
$public : string = null
$connect : string = ''
Return values
string

        
On this page

Search results