TYPO3\CMS\Core\IO\CsvStreamFilter Class Reference

Inheritance diagram for TYPO3\CMS\Core\IO\CsvStreamFilter:

Public Member Functions
	filter ($in, $out, &$consumed, $closing)

Static Public Member Functions
static	applyStreamFilter ($stream, bool $LF=true)

Static Protected Member Functions
static	registerStreamFilter ()
static	buildStreamFilterModifier (string $sequence)

Protected Attributes
const	NAME = 'csv.typo3'

Detailed Description

Inspired by https://csv.thephpleague.com/9.0/interoperability/enclose-field/

A unique sequence is added to relevant CSV field values in order to trigger enclosure in fputcsv. This stream filter is taking care of removing that sequence again when actually writing to stream.

Definition at line 26 of file CsvStreamFilter.php.

Member Function Documentation

applyStreamFilter()

static TYPO3\CMS\Core\IO\CsvStreamFilter::applyStreamFilter (   $stream, bool  $LF = true  )

static

Parameters

resource	$stream
bool	$LF	‪whether to apply line-feed

Examples

/mnt/doxygen/typo3/sysext/core/Classes/IO/CsvStreamFilter.php.

Definition at line 70 of file CsvStreamFilter.php.

References TYPO3\CMS\Core\IO\CsvStreamFilter\buildStreamFilterModifier(), and TYPO3\CMS\Core\IO\CsvStreamFilter\registerStreamFilter().

Referenced by TYPO3\CMS\Core\Utility\CsvUtility\csvValues().

buildStreamFilterModifier()

static TYPO3\CMS\Core\IO\CsvStreamFilter::buildStreamFilterModifier ( string  $sequence )

staticprotected

Examples

/mnt/doxygen/typo3/sysext/core/Classes/IO/CsvStreamFilter.php.

Definition at line 98 of file CsvStreamFilter.php.

Referenced by TYPO3\CMS\Core\IO\CsvStreamFilter\applyStreamFilter().

filter()

TYPO3\CMS\Core\IO\CsvStreamFilter::filter	(		$in,
			$out,
		&	$consumed,
			$closing
	)

Examples

/mnt/doxygen/typo3/sysext/core/Classes/IO/CsvStreamFilter.php.

Definition at line 47 of file CsvStreamFilter.php.

registerStreamFilter()

static TYPO3\CMS\Core\IO\CsvStreamFilter::registerStreamFilter ( )

staticprotected

Registers stream filter

Examples

/mnt/doxygen/typo3/sysext/core/Classes/IO/CsvStreamFilter.php.

Definition at line 87 of file CsvStreamFilter.php.

Referenced by TYPO3\CMS\Core\IO\CsvStreamFilter\applyStreamFilter().

Member Data Documentation

NAME

const TYPO3\CMS\Core\IO\CsvStreamFilter::NAME = 'csv.typo3'

protected

Examples

/mnt/doxygen/typo3/sysext/core/Classes/IO/CsvStreamFilter.php.

Definition at line 28 of file CsvStreamFilter.php.