(PHP 5 >= 5.1.0, PHP 7, PHP 8)
fputcsv — Formatea una línea en CSV y la escribe en un fichero
$stream,$fields,$separator = ",",$enclosure = "\"",$escape = "\\",$eol = "\n"
fputcsv() formatea la línea pasada como
fields (array) como CSV y la escribe
(terminada por un eol) en el stream especificado.
streamEl puntero de archivo debe ser válido y apuntar a un archivo abierto con éxito por fopen() o fsockopen() (y no cerrado aún por fclose()).
fieldsUn array de strings.
separator
El parámetro separator define el separador de campo.
Debe tratarse de un carácter de un solo byte.
enclosure
El parámetro enclosure define el carácter de encierro de los campos.
Debe tratarse de un carácter de un solo byte.
escape
El parámetro escape define el carácter de escape.
Debe tratarse de un carácter de un solo byte o una cadena vacía.
La cadena vacía ("") desactiva el mecanismo de escape propietario.
En el flujo de entrada, el carácter enclosure
siempre puede ser escapado duplicándolo dentro de una cadena entrecomillada,
lo que resulta en un único carácter enclosure
en el resultado analizado.
El carácter escape funciona de manera diferente:
si una secuencia de caracteres escape y
enclosure aparece en la entrada,
ambos caracteres estarán presentes en el resultado analizado.
Así, para los parámetros por defecto, una línea CSV como
"a""b","c\"d" tendrá los campos analizados como
a"b y c\"d, respectivamente.
A partir de PHP 8.4.0, el uso del valor por omisión de
escape está deprecado.
Debe ser proporcionado explícitamente ya sea por posición o mediante el uso
de los argumentos nombrados.
eol
El parámetro opcional eol define una secuencia
de fin de línea personalizada.
Cuando escape se define con un valor diferente a una cadena vacía
(""), puede resultar en un CSV que no sea compatible con
» RFC 4180 o que no pueda sobrevivir a un ciclo de ida y vuelta
a través de las funciones CSV de PHP. El valor predeterminado de escape es
"\\", por lo que se recomienda definirlo explícitamente como cadena vacía.
El valor predeterminado cambiará en una futura versión de PHP, no antes de PHP 9.0.
Nota:
Si un carácter
enclosureestá contenido en un campo, será escapado duplicándolo, a menos que esté inmediatamente precedido por unescape.
Devuelve el tamaño de la cadena escrita o false si ocurre un error.
Genera una ValueError si
separator o enclosure
no tiene una longitud de un byte.
Genera una ValueError si
escape no tiene una longitud de un byte o es una cadena vacía.
| Versión | Descripción |
|---|---|
| 8.4.0 |
Confiar en el valor por omisión de escape está ahora
deprecado.
|
| 8.1.0 |
Se añadió el parámetro opcional eol.
|
| 7.4.0 |
El parámetro escape ahora acepta una cadena vacía
para desactivar el mecanismo de escape propietario.
|
Ejemplo #1 Ejemplo con fputcsv()
<?php
$list = [
['aaa', 'bbb', 'ccc', 'dddd'],
['123', '456', '789'],
['"aaa"', '"bbb"']
];
$fp = fopen('file.csv', 'w');
foreach ($list as $fields) {
fputcsv($fp, $fields, ',', '"', '');
}
fclose($fp);
?>El ejemplo anterior escribirá lo siguiente en file.csv:
aaa,bbb,ccc,dddd 123,456,789 """aaa""","""bbb"""