(PHP 5 >= 5.3.0, PHP 7, PHP 8)
str_getcsv — Analiza una string CSV en un array
$string
,$separator
= ",",$enclosure
= "\"",$escape
= "\\"Analiza una cadena de caracteres que representa campos en formato CSV y devuelve un array que contiene todos los campos leídos.
Nota: Los parámetros de configuración local son tenidos en cuenta por esta función. Por ejemplo, los datos codificados en ciertos juegos de caracteres de un byte pueden ser analizados incorrectamente si
LC_CTYPE
esen_US.UTF-8
.
string
La cadena a analizar.
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.
Nota: Generalmente un carácter de encierro
enclosure
es escapado dentro de un campo duplicándolo; Sin embargo, el carácter de escapeescape
puede ser utilizado como alternativa. Por lo tanto, para los valores por omisión""
y\"
tienen el mismo significado. Además de escapar el carácter de encierroenclosure
el carácter de escapeescape
no tiene significado especial; ni siquiera para escapar a sí mismo.
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.
When escape
is set to anything other than an empty string
(""
) it can result in CSV that is not compliant with
» RFC 4180 or unable to survive a roundtrip
through the PHP CSV functions. The default for escape
is
"\\"
so it is recommended to set it to the empty string explicitly.
The default value will change in a future version of PHP, no earlier than PHP 9.0.
Devuelve un array que contiene los campos leídos.
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.4.0 |
Ahora lanza una ValueError si
separator , enclosure ,
o escape es inválido.
Esto imita el comportamiento de fgetcsv() y
fputcsv().
|
8.3.0 | Una cadena vacía es devuelta en lugar de una cadena que contiene un solo byte nulo para el último campo si este contiene únicamente un delimitador no terminado. |
7.4.0 |
El argumento escape interpreta ahora una cadena
vacía como señal para desactivar el mecanismo de escape propio.
Anteriormente, una cadena vacía era tratada como el valor por defecto del argumento.
|
Ejemplo #1 Ejemplo con str_getcsv()
<?php
$string = 'PHP,Java,Python,Kotlin,Swift';
$data = str_getcsv($string, escape: '\\');
var_dump($data);
?>
El resultado del ejemplo sería:
array(5) { [0]=> string(3) "PHP" [1]=> string(4) "Java" [2]=> string(6) "Python" [3]=> string(6) "Kotlin" [4]=> string(5) "Swift" }
Ejemplo #2 Ejemplo de str_getcsv() con una cadena vacía
Con una cadena vacía, esta función devuelve [null]
en lugar de un array vacío.
<?php
$string = '';
$data = str_getcsv($string, escape: '\\');
var_dump($data);
?>
El resultado del ejemplo sería:
array(1) { [0]=> NULL }