Documentation du code de SPIP et de ses plugins

SPIP

exporter_csv.php

Gestion d'export de données au format CSV

Table of Contents

Functions

exporter_csv_champ()  : string
Exporter un champ pour un export CSV : pas de retour a la ligne, et echapper les guillements par des doubles guillemets
exporter_csv_ligne_numerotee()  : string
Exporter une ligne complete au format CSV, avec delimiteur fourni
inc_exporter_csv_dist()  : string
Exporte une ressource sous forme de fichier CSV

Functions

exporter_csv_champ()

Exporter un champ pour un export CSV : pas de retour a la ligne, et echapper les guillements par des doubles guillemets

exporter_csv_champ(string $champ) : string
Parameters
$champ : string
Return values
string

exporter_csv_ligne_numerotee()

Exporter une ligne complete au format CSV, avec delimiteur fourni

exporter_csv_ligne_numerotee(int $nb, array<string|int, mixed> $ligne[, string $delim = ',' ][, string|null $importer_charset = null ][, callable $callback = null ]) : string
Parameters
$nb : int
$ligne : array<string|int, mixed>
$delim : string = ','
$importer_charset : string|null = null

Si défini exporte dans le charset indiqué

$callback : callable = null
Tags
uses
exporter_csv_champ()
Return values
string

inc_exporter_csv_dist()

Exporte une ressource sous forme de fichier CSV

inc_exporter_csv_dist(string $titre, array<string|int, mixed>|resource $resource[, array<string|int, mixed> $options = [] ]) : string

La ressource peut etre un tableau ou une resource SQL issue d'une requete Le nom du fichier est défini en fonction du titre s'il n'est pas indiqué dans les options. L'extension est choisie en fonction du délimiteur si elle n'est pas indiquée dans les options :

  • si on utilise ',' c'est un vrai csv avec extension csv
  • si on utilise ';' ou tabulation c'est pour E*cel, et on exporte en iso-truc, avec une extension .xls
Parameters
$titre : string

Titre utilisé pour nommer le fichier si celui-ci n'est pas indiqué dans les options Il peut s'agir d'un texte contenant de la syntaxe SPIP

$resource : array<string|int, mixed>|resource
$options : array<string|int, mixed> = []
  • (string) fichier : nom du fichier, par défaut défini en fonction du $titre
  • (string) extension : csv | xls, par défaut choisie en fonction du délimiteur
  • (string) delim : , | ; | \t | TAB
  • (array) entetes : tableau d'en-tetes pour nommer les colonnes (genere la premiere ligne)
  • (bool) envoyer : pour envoyer le fichier exporte (permet le telechargement)
  • (string) charset : charset de l'export si different de celui du site
  • (callable) callback : fonction callback a appeler sur chaque ligne pour mettre en forme/completer les donnees
Return values
string

        
On this page

Search results