Documentation du code de SPIP et de ses plugins

Medias

documents.php

Table of Contents

Constants

CHARSET_JOINT  = 'iso-8859-1'

Functions

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

Functions

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


        
On this page

Search results