Documentation du code de SPIP et de ses plugins

SPIP

Documents

Table of Contents

Functions

set_spip_doc()  : string
Donne le chemin du fichier relatif à `_DIR_IMG` pour stockage 'tel quel' dans la base de données
get_spip_doc()  : bool|string
Donne le chemin complet du fichier
creer_repertoire_documents()  : string
Créer un sous-répertoire IMG/$ext/ tel que IMG/pdf
effacer_repertoire_temporaire()  : mixed
Efface le répertoire de manière récursive !
copier_document()  : bool|mixed|string
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à
determine_upload()  : bool|string
Trouver le dossier utilisé pour upload un fichier
deplacer_fichier_upload()  : bool|mixed|string
Déplacer ou copier un fichier
check_upload_error()  : bool|string
Erreurs d'upload
corriger_extension()  : string
Corrige l'extension du fichier dans quelques cas particuliers

Functions

set_spip_doc()

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

set_spip_doc(string $fichier) : string
Parameters
$fichier : string
Tags
uses
_DIR_IMG
Return values
string

get_spip_doc()

Donne le chemin complet du fichier

get_spip_doc(string $fichier) : bool|string
Parameters
$fichier : string
Tags
uses
_DIR_IMG
Return values
bool|string

effacer_repertoire_temporaire()

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

effacer_repertoire_temporaire(string $nom) : mixed
Parameters
$nom : string

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à

copier_document(string $ext, string $orig, string $source[, string $subdir = null ]) : bool|mixed|string
Parameters
$ext : string
$orig : string
$source : string
$subdir : string = null
Return values
bool|mixed|string

deplacer_fichier_upload()

Déplacer ou copier un fichier

deplacer_fichier_upload(string $source, string $dest[, bool $move = false ]) : bool|mixed|string
Parameters
$source : string

Fichier source à copier

$dest : string

Fichier de destination

$move : bool = false
  • true : on déplace le fichier source vers le fichier de destination
  • false : valeur par défaut. On ne fait que copier le fichier source vers la destination.
Tags
uses
_DIR_RACINE
uses
spip_unlink()
Return values
bool|mixed|string

check_upload_error()

Erreurs d'upload

check_upload_error(int $error[, string $msg = '' ][, bool $return = false ]) : bool|string

Renvoie false si pas d'erreur et true s'il n'y a pas de fichier à uploader. Pour les autres erreurs, on affiche le message d'erreur et on arrête l'action.

Parameters
$error : int
$msg : string = ''
$return : bool = false
Tags
link

Explication sur les messages d'erreurs de chargement de fichiers.

uses
propre()
uses
minipres()
global

string $spip_lang_right

Return values
bool|string

corriger_extension()

Corrige l'extension du fichier dans quelques cas particuliers

corriger_extension(string $ext) : string
Parameters
$ext : string
Tags
note

Une extension 'pdf ' passe dans la requête de contrôle mysql> SELECT * FROM spip_types_documents WHERE extension="pdf ";

todo

À passer dans base/typedoc

Return values
string

        
On this page

Search results