Documentation du code de SPIP et de ses plugins

Medias

ajouter_documents.php

Table of Contents

Constants

_TITRER_DOCUMENTS  = false

Functions

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

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

        
On this page

Search results