str_getcsv - PHP code example

The PHP Function Str_GetCSV

The php function str_getcsv is used to parse a string input for fields in CSV (Comma Separated Values) format. It helps developers in efficient extraction and manipulation of structured data stored in this popular file format. With its support for various scenarios like quoted strings, custom delimiters and escaping special characters, str_getcsv empowers developers to import/export data and perform other data analysis tasks.

Unlike other php functions that reads from files, this function accepts a string as its input. It is also more flexible than fgetcsv() as it doesn't require a file handle.

The str_getcsv() function takes one mandatory parameter, the string to be parsed. It also accepts three optional parameters, the field delimiter, the field enclosure character and the escape character. It returns an indexed array containing the fields read.

Note: Since PHP 7.4.0 an empty string ("") for the escape parameter disables the proprietary escape mechanism. Previously it was treated as the default value.

Lastly, you can use a combination of str_getcsv() and array_map() to read the entire CSV file into an associative array. This can be much more efficient than reading the file with file() and using fgetcsv() for each line of the file.

I hope you found this article useful. Please share it with your friends and colleagues who might be interested in it. Feel free to contact me for any further questions, suggestions and concerns. Thank you for your time.

str_getcsv example

// Sort and make the array values unique.     sort($declared[MigrationState::FINISHED]);
    sort($declared[MigrationState::NOT_FINISHED]);
    $declared_unique[MigrationState::FINISHED] = array_unique($declared[MigrationState::FINISHED]);
    $declared_unique[MigrationState::NOT_FINISHED] = array_unique($declared[MigrationState::NOT_FINISHED]);
    sort($discovered);
    $discovered_unique = array_unique($discovered);

    // Assert that each discovered migration has a corresponding declaration     // in a migrate_drupal.yml.     foreach ($discovered_unique as $datum) {
      $data = str_getcsv($datum);
      $in_finished = in_array($datum, $declared_unique[MigrationState::FINISHED]);
      $in_not_finished = in_array($datum, $declared_unique[MigrationState::NOT_FINISHED]);
      $found = $in_finished || $in_not_finished;
      $this->assertTrue($found, sprintf("No migration state found for version '%s' with source_module '%s' and destination_module '%s' declared in module '%s'", $version, $data[1], $data[2], $data[0]));
    }

    // Remove the declared finished from the discovered, leaving just the not     // finished, if there are any. These should have an entry in the declared     // not finished.     $discovered_not_finished = array_diff($discovered_unique, $declared_unique[MigrationState::FINISHED]);
    foreach ($discovered_not_finished as $datum) {

private function readPropertiesFromRegistry(array $properties): array
    {
        $items = [];

        $registryContent = file_get_contents('https://www.swift.com/swift-resource/11971/download');
        $lines = explode("\n", $registryContent);

        // skip header line         array_shift($lines);

        foreach ($lines as $line) {
            $columns = str_getcsv($line, "\t");
            $propertyLabel = array_shift($columns);

            if (!isset($properties[$propertyLabel])) {
                continue;
            }

            $propertyField = $properties[$propertyLabel];

            foreach ($columns as $index => $value) {
                $items[$index][$propertyField] = $value;
            }
        }

                if (!\is_scalar($value)) {
                    throw new RuntimeException(sprintf('Parameter "%s" found when resolving env var "%s" must be scalar, "%s" given.', $match[1], $name, get_debug_type($value)));
                }

                return $value;
            }, $env);
        }

        if ('csv' === $prefix) {
            return '' === $env ? [] : str_getcsv($env, ',', '"', '');
        }

        if ('trim' === $prefix) {
            return trim($env);
        }

        throw new RuntimeException(sprintf('Unsupported env var prefix "%s" for env name "%s".', $prefix, $name));
    }
}

$file = $this->getIndexFilename();

        if (!file_exists($file)) {
            return [];
        }

        $file = fopen($file, 'r');
        fseek($file, 0, \SEEK_END);

        $result = [];
        while (\count($result) < $limit && $line = $this->readLineFromFile($file)) {
            $values = str_getcsv($line);

            if (7 !== \count($values)) {
                // skip invalid lines                 continue;
            }

            [$csvToken, $csvIp, $csvMethod, $csvUrl, $csvTime, $csvParent, $csvStatusCode] = $values;
            $csvTime = (int) $csvTime;

            if ($ip && !str_contains($csvIp, $ip) || $url && !str_contains($csvUrl, $url) || $method && !str_contains($csvMethod, $method) || $statusCode && !str_contains($csvStatusCode, $statusCode)) {
                continue;
            }

if (!$return_path_set) {
        $message['Return-Path'] = $message['headers']['Return-Path'];
        unset($message['headers']['Return-Path']);
      }
    }

    $headers = new Headers();
    foreach ($message['headers'] as $name => $value) {
      if (in_array(strtolower($name), self::MAILBOX_LIST_HEADERS, TRUE)) {
        // Split values by comma, but ignore commas encapsulated in double         // quotes.         $value = str_getcsv($value, ',');
      }
      $headers->addHeader($name, $value);
    }
    $line_endings = Settings::get('mail_line_endings', PHP_EOL);
    // Prepare mail commands.     $mail_subject = (new UnstructuredHeader('subject', $message['subject']))->getBodyAsString();
    // Note: email uses CRLF for line-endings. PHP's API requires LF     // on Unix and CRLF on Windows. Drupal automatically guesses the     // line-ending format appropriate for your system. If you need to     // override this, adjust $settings['mail_line_endings'] in settings.php.     $mail_body = preg_replace('@\r?\n@', $line_endings, $message['body']);

'File 1 title',
                    'February 16th, 2023',
                    '1 MB',
                ],
                [
                    'File 2.jpg',
                    'File 2 title',
                    'February 16th, 2023',
                    '1 MB',
                ],
            ],
            array_map(str_getcsv(...), explode("\n", $commandTester->getDisplay(true)))
        );
    }

    /** * This method builds a naive regex to check that each table contains the correct amount of files * and whether the continue/abort behaviour works. */
    private function buildTableRegex(int $numFiles, bool $addAbortMessage = false): string
    {
        $regex = '#^';
        $pages = 1;