documents.php
SPIP, Système de publication pour l'internet
Copyright © avec tendresse depuis 2001 Arnaud Martin, Antoine Pitrou, Philippe Rivière, Emmanuel Saint-James
Ce programme est un logiciel libre distribué sous licence GNU/GPL.
Table of Contents
Constants
- CHARSET_JOINT = 'iso-8859-1'
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
- 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à
- effacer_repertoire_temporaire() : mixed
- Efface le répertoire de manière récursive !
- 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>
Constants
CHARSET_JOINT
public
mixed
CHARSET_JOINT
= 'iso-8859-1'
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|null $fichier) : string
Parameters
- $fichier : string|null
Tags
Return values
stringget_spip_doc()
Donne le chemin complet du fichier
get_spip_doc(string|null $fichier) : bool|string
Parameters
- $fichier : string|null
Tags
Return values
bool|stringcopier_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|stringeffacer_repertoire_temporaire()
Efface le répertoire de manière récursive !
effacer_repertoire_temporaire(string $nom) : mixed
Parameters
- $nom : string
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