Abrir Arquivos CSV com PHP

Introdução

CSV (Comma-Separated Values) é um formato de arquivo texto para armazenamento de dados de forma bastante simples, e agrupada na forma de tabela (planilha). Ele pode ser gerado com qualquer editor de texto puro (TXT), bastando seguir as regras de sintaxe (definidas em RFC 4180).

Este formato é bastante útil para exportação e importação de dados entre sistemas. Você pode, por exemplo, pedir para uma tabela do MySQL ser exportada para CSV e, então, ser importada pelo seu sistema que utiliza outro banco de dados.

Sintaxe do CSV

Todo arquivo CSV define dois caracteres especiais: um "delimitador de valores" e uma "cerca de valor". Normalmente o delimitador é a vírgula e a cerca são as aspas duplas. A cerca serve para envolver o valor de uma célula da planilha (linha x coluna) e o delimitador serve para separar o valor de uma célula de outra.

Cada linha da planilha é delimitada por uma quebra de linha no arquivo CSV, porém, nem toda quebra de linha no arquivo CSV indica uma nova linha da planilha.

A utilização da cerca é obrigatória apenas quando o valor possua quebra de linha, o caractere delimitador ou o caractere cerca internamente. Quando um valor é delimitado por uma cerca e este mesmo caractere está presente no valor, então o caractere do valor deve ser escapado com o caractere de cerca (ficam dois caracteres de cerca em sequencia).

A primeira linha da planilha CSV pode ser o cabeçalho dos campos. Neste caso, é caracterizado um CSV com cabeçalho.

Exemplo de arquivo CSV

Veja uma tabela de exemplo e o respectivo arquivo CSV para representá-la:

nome	nome informal	ano
Luiz Inácio da Silva	Luiz Inácio "Lula" da Silva	2003
Dilma Rousseff	Dilma	2011

Arquivo CSV:

nome,nome informal,ano
Luís Inácio da Silva,"Luís Inácio ""Lula"" da Silva",2003
Dilma Rousseff,Dilma,2011

Note que o nome informal do primeiro registro possui o caractere cerca, logo, foi preciso obrigatoriamente delimitar o valor com o caractere cerca e escapar os caracteres cercas internos.

Leitura e Escrita de CSV com PHP

Para leitura e escrita de arquivo CSV com PHP, basta abrir um arquivo para leitura ou escrita normalmente (fopen), mas, ao invés de usar funções como fgets ou fputs, utilizar as funções:

• fgetcsv - Para ler um registro (uma linha) do arquivo CSV.
• fputcsv - Para incluir um registro (uma linha) em um arquivo CSV.

<?php
// Exemplo de scrip para exibir os nomes obtidos no arquivo CSV de exemplo

$delimitador = ',';
$cerca = '"';

// Abrir arquivo para leitura
$f = fopen('teste.csv', 'r');
if ($f) { 

    // Ler cabecalho do arquivo
    $cabecalho = fgetcsv($f, 0, $delimitador, $cerca);

    // Enquanto nao terminar o arquivo
    while (!feof($f)) { 

        // Ler uma linha do arquivo
        $linha = fgetcsv($f, 0, $delimitador, $cerca);
        if (!$linha) {
            continue;
        }

        // Montar registro com valores indexados pelo cabecalho
        $registro = array_combine($cabecalho, $linha);

        // Obtendo o nome
        echo $registro['nome'].PHP_EOL;
    }
    fclose($f);
}

Note que foi utilizada a função array_combine apenas para facilitar a localização dos valores do registro lido através do nome usado no cabeçalho do arquivo. Caso o arquivo não tenha cabeçalho, basta acessar a posição numérica do array $linha. Por exemplo: a posição 0 (zero) guarda o nome, a posição 1 guarda o nome informal e a posição 2 guarda o ano.

O segundo parâmetro de fgetcsv é apenas um número para indicar o tamanho máximo do registro, caso exista. Caso não exista, basta usar o valor zero.

O procedimento para gerar um arquivo CSV também é simples:

<?php
$delimitador = ',';
$cerca = '"';

$dados = array(
    array('nome', 'idade'),
    array('Rubens Takiguti Ribeiro', 26),
    array('Teste "da Silva" Sauro', 327)
);

$f = fopen('teste2.csv', 'w');
if ($f) { 
    foreach ($dados as $linha) {
        fputcsv($f, $linha, $delimitador, $cerca);
    }
    fclose($f);
}

Por algum motivo (talvez de compatibilidade), a função fputcsv utiliza o caractere de cerca para delimitar valores que tenham espaço (além dos outros caracteres citados). Porém, isso não prejudica a leitura do arquivo.

Enviando um CSV para o cliente

Sabendo como gerar um CSV, para enviá-lo para o cliente (navegador), basta utilizar o cabeçalho HTTP correto e imprimir o conteúdo do documento. Para isso, é usado o mime-type "text/csv", especificada a codificação do arquivo e, opcionalmente, a especificado se o arquivo possui ou não o cabeçalho. Também podemos especificar se o arquivo será enviado para exibição pelo navegador (disposition inline) ou se será enviado para download (disposition attachment), e colocar uma sugestão de nome de arquivo, conforme exemplo a seguir:

<?php
// Gerando o CSV em $arquivo_csv
...

// Enviando o CSV para o usuario
header('Content-type: text/csv; charset=UTF-8; header=present');
header('Content-Disposition: attachment; filename="' . basename($arquivo_csv) . '"');
readfile($arquivo_csv);
exit(0);

Caso você não queira enviar o conteúdo do CSV para um arquivo físico para só depois imprimí-lo com a função readfile, como no exemplo anterior, você pode ir imprimindo o conteúdo dinamicamente. Para isso, basta chamar a função fopen passando o manipulador de I/O "php://output", como no exemplo abaixo:

<?php
$dados = ...
$cabecalho = ...
$delimitador = ...
$cerca = ...

$f = fopen('php://output', 'w');
if ($f) {
    header('Content-Type: text/csv; charset=UTF-8; header=present');
    header('Content-Disposition: inline; filename="teste.csv"');
    fputcsv($f, $cabecalho, $delimitador, $cerca);
    foreach ($dados as $linha) {
        fputcsv($f, $linha, $delimitador, $cerca);
    }
    fclose($f);
}
exit(0);

Desta forma, ao chamar o fputcsv, o resultado é jogado diretamente para a saída, como se estivéssemos executando um echo, print ou similar.

Compatibilidade de CSV

Sabe-se que o OpenOffice.org abre arquivos CSV corretamente, desde que sejam informados os caracteres utilizados. Porém, algumas versões do MS-Office tem alguns probleminhas, especialmente quanto ao uso opcional do caractere de cerca. Para evitar problemas, basta criar sua própria função para gerar um registro CSV e sempre incluir a cerca:

function myfputcsv($handle, $fields, $delimiter = ',', $enclosure = '"') {
    foreach ($fields as &$field) {
        $field = $enclosure.str_replace($enclosure, $enclosure.$enclosure, $field).$enclosure;
    }
    $line = implode($delimiter, $fields).PHP_EOL;
    return fwrite($handle, $line);
}

Existem, ainda, variações de CSV com outros nomes, que fazem parte do grupo de "Delimiter-Separated Values" (Valores Separados por Delimitador). Por exemplo, o TSV (Tab-Separated Values ou Valores Separador por Tab). A sintaxe é a mesma, só muda o caractere utilizado.

Observação

Conforme foi dito, uma quebra de linha em um arquivo CSV não indica um novo registo. Portanto, o número de quebras de linhas não determina o número de linhas da planilha. Ou seja, nada de usar explode, file, ou coisas do tipo para determinar a quantidade de registros.

Veja um exemplo onde um registro começa em uma linha, mas termina na outra:

frase,autor
"Não sabendo que era impossível,
foi lá e fez.","Jean Cocteau"
"Se queres prever o futuro, estuda o passado.","Confúcio"

Veja que o arquivo possui 4 linhas, mas apenas 2 registros.