PHP 8.5.0 Alpha 1 available for testing

SplFileObject::setCsvControl

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

SplFileObject::setCsvControlDefine las opciones CSV

Descripción

public SplFileObject::setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\"): void

Define el delimitador, el carácter de escape y el carácter utilizado para encerrar los campos CSV analizados.

Parámetros

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 escape escape 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 encierro enclosure el carácter de escape escape no tiene significado especial; ni siquiera para escapar a sí mismo.

Advertencia

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.

Advertencia

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.

Valores devueltos

No devuelve ningún valor.

Errores/Excepciones

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.

Historial de cambios

Versión Descripción
8.4.0 Confiar en el valor por omisión de escape está ahora deprecado.
7.4.0 El argumento escape acepta ahora una cadena de caracteres vacía para desactivar el mecanismo de escape propietario.

Ejemplos

Ejemplo #1 Ejemplo con SplFileObject::setCsvControl()

<?php
$file
= new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');
foreach (
$file as $row) {
list (
$fruit, $quantity) = $row;
// Operación sobre los datos
}
?>

Contenido de data.csv

<?php
apples|20
bananas|14
cherries|87
?>

Ver también

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top