array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'es', ), 'this' => array ( 0 => 'splfileobject.setcsvcontrol.php', 1 => 'SplFileObject::setCsvControl', 2 => 'Define las opciones CSV', ), 'up' => array ( 0 => 'class.splfileobject.php', 1 => 'SplFileObject', ), 'prev' => array ( 0 => 'splfileobject.seek.php', 1 => 'SplFileObject::seek', ), 'next' => array ( 0 => 'splfileobject.setflags.php', 1 => 'SplFileObject::setFlags', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'es', 'path' => 'reference/spl/splfileobject/setcsvcontrol.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

SplFileObject::setCsvControl

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

SplFileObject::setCsvControl — Define 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.

Advertencia

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.

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

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.

Valores devueltos

No se retorna 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