str_getcsv

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

str_getcsv Parse a CSV string into an array

Опис

str_getcsv(
    string $string,
    string $separator = ",",
    string $enclosure = "\"",
    string $escape = "\\"
): array

Parses a string input for fields in CSV format and returns an array containing the fields read.

Зауваження: The locale settings are taken into account by this function. For example, data encoded in certain one-byte encodings may be parsed incorrectly if LC_CTYPE is en_US.UTF-8.

Параметри

string

The string to parse.

separator

The separator parameter sets the field separator. It must be a single byte character.

enclosure

The enclosure parameter sets the field enclosure character. It must be a single byte character.

escape

The escape parameter sets the escape character. It must be a single byte character or the empty string. The empty string ("") disables the proprietary escape mechanism.

Зауваження: Usually an enclosure character is escaped inside a field by doubling it; however, the escape character can be used as an alternative. So for the default parameter values "" and \" have the same meaning. Other than allowing to escape the enclosure character the escape character has no special meaning; it isn't even meant to escape itself.

Увага

As of PHP 8.4.0, depending on the default value of escape is deprecated. It needs to be provided explicitly either positionally or by the use of named arguments.

Увага

Якщо значенням параметра escape не є порожній рядок (""), то результатом може бути CSV, що не відповідає вимогам » RFC 4180 або не зможе оброблятись функціями PHP CSV. Типовим значенням параметра escape є "\\", але рекомендовано явно вказати порожній рядок. Типове значення зміниться в наступній версії PHP, та не раніше, ніж в PHP 9.0.

Значення, що повертаються

Returns an indexed array containing the fields read.

Помилки/виключення

Throws a ValueError if separator or enclosure is not one byte long.

Throws a ValueError if escape is not one byte long or the empty string.

Журнал змін

Версія Опис
8.4.0 Relying on the default value of escape is now deprecated.
8.4.0 Now throws a ValueError if separator, enclosure, or escape is invalid. This mimics the behavior of fgetcsv() and fputcsv().
8.3.0 An empty string is returned instead of a string with a single null byte for the last field if it contains only an unterminated enclosure.
7.4.0 The escape parameter now interprets an empty string as signal to disable the proprietary escape mechanism. Formerly, an empty string was treated like the default parameter value.

Приклади

Приклад #1 str_getcsv() example

<?php

$string
= 'PHP,Java,Python,Kotlin,Swift';
$data = str_getcsv($string);

var_dump($data);
?>

Поданий вище приклад виведе:

array(5) {
  [0]=>
  string(3) "PHP"
  [1]=>
  string(4) "Java"
  [2]=>
  string(6) "Python"
  [3]=>
  string(6) "Kotlin"
  [4]=>
  string(5) "Swift"
}

Приклад #2 str_getcsv() example with an empty string

Застереження

On an empty string this function returns the value [null] instead of an empty array.

<?php

$string
= '';
$data = str_getcsv($string);

var_dump($data);
?>

Поданий вище приклад виведе:

array(1) {
  [0]=>
  NULL
}

Прогляньте також