renseigner_document.php
Fonctions pour compléter les informations connues d'un document
Table of Contents
Functions
- renseigner_source_distante() : array<string|int, mixed>|string
- Récuperer les infos distantes d'une URL, et renseigner pour une insertion en base
- renseigner_taille_dimension_image() : array<string|int, mixed>|string
- Renseigner les informations de taille et dimension d'un document
- sanitizer_document() : bool
Functions
renseigner_source_distante()
Récuperer les infos distantes d'une URL, et renseigner pour une insertion en base
renseigner_source_distante(string $source[, mixed $callback_valider_url = '' ]) : array<string|int, mixed>|string
Utilise une variable static car appellée plusieurs fois au cours du même hit (vérification puis traitement)
Un plugin peut avec le pipeline renseigner_document_distant renseigner les informations fichier et mode avant l'analyse et traitement par ce plugin, qui dans ce cas ne les fera pas. Exemple : OEmbed
Parameters
- $source : string
-
URL du document
- $callback_valider_url : mixed = ''
Tags
Return values
array<string|int, mixed>|string —Informations sur le fichier distant, sinon message d'erreur. Sans erreur, retourne un tableau :
- source : URL du fichier
- distant : Est-ce un fichier distant ?
- mode : Mode d'inclusion
- fichier : Chemin local du fichier s'il a été recopié
renseigner_taille_dimension_image()
Renseigner les informations de taille et dimension d'un document
renseigner_taille_dimension_image(string $fichier, string $ext[, bool $distant = false ]) : array<string|int, mixed>|string
Récupère les informations de taille (largeur / hauteur / type_image / taille) d'un document Utilise pour cela les fonctions du répertoire metadatas/*
Ces fonctions de récupérations peuvent retourner d'autres champs si ces champs sont définis comme editable dans la déclaration de la table spip_documents
Parameters
- $fichier : string
-
Le fichier à examiner
- $ext : string
-
L'extension du fichier à examiner
- $distant : bool = false
-
Indique que le fichier peut etre distant, on essaiera alors d'en recuperer un bout pour en lire les meta infos
Tags
Return values
array<string|int, mixed>|string —$infos
- Si c'est une chaîne, c'est une erreur
- Si c'est un tableau, l'ensemble des informations récupérées du fichier
sanitizer_document()
sanitizer_document(string $fichier, string $ext) : bool
Parameters
- $fichier : string
- $ext : string