SplFileObject::setCsvControl

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

SplFileObject::setCsvControl — Устанавливает символы разделителя, ограничителя и экранирования для CSV-полей

Описание

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

Метод устанавливает символы разделителя полей, ограничителя значений полей и экранирования для разбора CSV-полей.

Список параметров

separator: Параметр separator устанавливает разделитель полей и принимает только один однобайтовый символ.
enclosure: Параметр enclosure устанавливает символ для обозначения границ значения поля и принимает только один однобайтовый символ; часть строки внутри ограничителей разбирается как значение одного поля, даже если содержит символ-разделитель.
escape: Параметр escape устанавливает символ экранирования и принимает только один однобайтовый символ или пустую строку. Пустая строка "" отключает внутренний механизм экранирования.

Внимание
Дублирование символа enclosure внутри обозначенных символом границ вернёт в результате разбора входного потока один символ enclosure. Параметр escape работает по-другому: при добавлении символа escape перед символом enclosure оба символа вернутся в результате разбора, поэтому со стандартными значениями параметров CSV-строка наподобие "a""b","c\"d" разберётся на два поля — a"b и c\"d.

Внимание
Начиная с PHP 8.4.0 вызов без явной передачи аргумента escape устарел. Символ экранирования теперь передаётся при каждом вызове функции позиционно или как именованный аргумент, даже если значение аргумента совпадает с предустановленным значением параметра.

Внимание

Строка в CSV-формате иногда перестаёт соответствовать стандарту » RFC 4180 или не выдерживает обмена информацией с PHP-функциями для работы с CSV-строками, если для символа экранирования escape устанавливают значение, которое отличается от пустой строки "". Значение по умолчанию для параметра escape — "\\", поэтому рекомендуют явно указывать пустую строку. Значение по умолчанию изменят в будущей версии PHP, но не раньше PHP 9.0.

Возвращаемые значения

Функция не возвращает значения после выполнения.

Ошибки

Функция выбрасывает ошибку ValueError, если значение аргумента separator или enclosure не равно одному байту.

Функция выбрасывает ошибку ValueError, если значение аргумента escape не равно одному байту или пустой строке.

Список изменений

Версия	Описание
8.4.0	Вызов функции без явной передачи аргумента `escape` устарел.
7.4.0	Параметр `escape` теперь принимает пустую строку для отключения внутреннего механизма экранирования.

Примеры

Пример #1 Пример установки символов разделителя, ограничителя и экранирования методом SplFileObject::setCsvControl()

<?php

$file = new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');

foreach ($file as $row) {
    list ($fruit, $quantity) = $row;
    // Обрабатываем значения
}

?>

Содержимое файла data.csv

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

Смотрите также

SplFileObject::getCsvControl() - Получает символы разделителя, ограничителя и экранирования CSV-полей
SplFileObject::fgetcsv() - Получает строку из файлового указателя и разбирает по CSV-полям
SplFileObject::fputcsv() - Записывает массив полей как CSV-строки
fputcsv() - Формирует строку в CSV-формате и записывает строку в файловый указатель
fgetcsv() - Получает строку из файлового указателя и разбирает по CSV-полям
str_getcsv() - Разбирает CSV-строку в массив

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы