PhpOffice\PhpSpreadsheet\Reader\Csv Class Reference

Inheritance diagram for PhpOffice\PhpSpreadsheet\Reader\Csv:

Collaboration diagram for PhpOffice\PhpSpreadsheet\Reader\Csv:

Public Member Functions
	__construct ()
	Create a new CSV Reader instance. More...
	setInputEncoding (string $pValue)
	getInputEncoding ()
	setFallbackEncoding (string $pValue)
	getFallbackEncoding ()
	listWorksheetInfo (string $pFilename)
	Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns). More...
	load ($pFilename)
	Loads Spreadsheet from file. More...
	loadIntoExisting (string $pFilename, Spreadsheet $spreadsheet)
	Loads PhpSpreadsheet from file into PhpSpreadsheet instance. More...
	getDelimiter ()
	setDelimiter (string $delimiter)
	getEnclosure ()
	setEnclosure (string $enclosure)
	getSheetIndex ()
	setSheetIndex (int $pValue)
	setContiguous (bool $contiguous)
	getContiguous ()
	setEscapeCharacter (string $escapeCharacter)
	getEscapeCharacter ()
	canRead ($pFilename)
	Can the current IReader read the file? More...
Public Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	__construct ()
	IReader constructor. More...
	getReadDataOnly ()
	Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information. More...
	setReadDataOnly ($pValue)
	Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. More...
	getReadEmptyCells ()
	Read empty cells? If this is true (the default), then the Reader will read data values for all cells, irrespective of value. More...
	setReadEmptyCells ($pValue)
	Set read empty cells Set to true (the default) to advise the Reader read data values for all cells, irrespective of value. More...
	getIncludeCharts ()
	Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook. More...
	setIncludeCharts ($pValue)
	Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. More...
	getLoadSheetsOnly ()
	Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded. More...
	setLoadSheetsOnly ($value)
	Set which sheets to load. More...
	setLoadAllSheets ()
	Set all sheets to load Tells the Reader to load all worksheets from the workbook. More...
	getReadFilter ()
	Read filter. More...
	setReadFilter (IReadFilter $pValue)
	Set read filter. More...
	getSecurityScanner ()

Static Public Member Functions
static	setConstructorCallback (?callable $callback)
	Set a callback to change the defaults. More...
static	getConstructorCallback ()
static	guessEncoding (string $filename, string $dflt=self::DEFAULT_FALLBACK_ENCODING)

Data Fields
const	DEFAULT_FALLBACK_ENCODING = 'CP1252'
const	GUESS_ENCODING = 'guess'
const	UTF8_BOM = "\xEF\xBB\xBF"
const	UTF8_BOM_LEN = 3
const	UTF16BE_BOM = "\xfe\xff"
const	UTF16BE_BOM_LEN = 2
const	UTF16BE_LF = "\x00\x0a"
const	UTF16LE_BOM = "\xff\xfe"
const	UTF16LE_BOM_LEN = 2
const	UTF16LE_LF = "\x0a\x00"
const	UTF32BE_BOM = "\x00\x00\xfe\xff"
const	UTF32BE_BOM_LEN = 4
const	UTF32BE_LF = "\x00\x00\x00\x0a"
const	UTF32LE_BOM = "\xff\xfe\x00\x00"
const	UTF32LE_BOM_LEN = 4
const	UTF32LE_LF = "\x0a\x00\x00\x00"

Protected Member Functions
	skipBOM ()
	Move filepointer past any BOM marker. More...
	checkSeparator ()
	Identify any separator that is explicitly set in the file. More...
	inferSeparator ()
	Infer the separator if it isn't explicitly set in the file or specified by the user. More...
Protected Member Functions inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	openFile ($pFilename)
	Open file for reading. More...

Private Member Functions
	openFileOrMemory (string $pFilename)

Static Private Member Functions
static	extractStringLower ($extension)
	Scrutinizer believes, incorrectly, that the specific pathinfo call in canRead can return something other than an array. More...
static	guessEncodingTestNoBom (string &$encoding, string &$contents, string $compare, string $setEncoding)
static	guessEncodingNoBom (string $filename)
static	guessEncodingTestBom (string &$encoding, string $first4, string $compare, string $setEncoding)
static	guessEncodingBom (string $filename)

Private Attributes
	$inputEncoding = 'UTF-8'
	$fallbackEncoding = self::DEFAULT_FALLBACK_ENCODING
	$delimiter
	$enclosure = '"'
	$sheetIndex = 0
	$contiguous = false
	$escapeCharacter = '\\'

Static Private Attributes
static	$constructorCallback

Additional Inherited Members
Protected Attributes inherited from PhpOffice\PhpSpreadsheet\Reader\BaseReader
	$readDataOnly = false
	$readEmptyCells = true
	$includeCharts = false
	$loadSheetsOnly
	$readFilter
	$fileHandle
	$securityScanner

Detailed Description

Definition at line 11 of file Csv.php.

Constructor & Destructor Documentation

__construct()

PhpOffice\PhpSpreadsheet\Reader\Csv::__construct

(

)

Create a new CSV Reader instance.

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 89 of file Csv.php.

    {
        parent::__construct();
        $callback = self::$constructorCallback;
        if ($callback !== null) {
            $callback($this);
        }
    }

Member Function Documentation

canRead()

PhpOffice\PhpSpreadsheet\Reader\Csv::canRead

(

$pFilename

)

Can the current IReader read the file?

Parameters

string

$pFilename

Returns

bool

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 418 of file Csv.php.

References $type, and PhpOffice\PhpSpreadsheet\Reader\BaseReader\openFile().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory().

    {
        // Check if file exists
        try {
            $this->openFile($pFilename);
        } catch (InvalidArgumentException $e) {
            return false;
        }

        fclose($this->fileHandle);

        // Trust file extension if any
        $extension = self::extractStringLower(pathinfo($pFilename, PATHINFO_EXTENSION));
        if (in_array($extension, ['csv', 'tsv'])) {
            return true;
        }

        // Attempt to guess mimetype
        $type = mime_content_type($pFilename);
        $supportedTypes = [
            'application/csv',
            'text/csv',
            'text/plain',
            'inode/x-empty',
        ];

        return in_array($type, $supportedTypes, true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkSeparator()

PhpOffice\PhpSpreadsheet\Reader\Csv::checkSeparator ( )

protected

Identify any separator that is explicitly set in the file.

Definition at line 153 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\skipBOM().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting().

                                       : void
    {
        $line = fgets($this->fileHandle);
        if ($line === false) {
            return;
        }

        if ((strlen(trim($line, "\r\n")) == 5) && (stripos($line, 'sep=') === 0)) {
            $this->delimiter = substr($line, 4, 1);

            return;
        }

        $this->skipBOM();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

extractStringLower()

static PhpOffice\PhpSpreadsheet\Reader\Csv::extractStringLower (   $extension )

staticprivate

Scrutinizer believes, incorrectly, that the specific pathinfo call in canRead can return something other than an array.

Phpstan knows better. This function satisfies both.

Parameters

mixed

$extension

Definition at line 406 of file Csv.php.

                                                          : string
    {
        return is_string($extension) ? strtolower($extension) : '';
    }

getConstructorCallback()

static PhpOffice\PhpSpreadsheet\Reader\Csv::getConstructorCallback ( )

static

Definition at line 109 of file Csv.php.

                                                   : ?callable
    {
        return self::$constructorCallback;
    }

getContiguous()

PhpOffice\PhpSpreadsheet\Reader\Csv::getContiguous

(

)

Definition at line 381 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$contiguous.

                                   : bool
    {
        return $this->contiguous;
    }

getDelimiter()

PhpOffice\PhpSpreadsheet\Reader\Csv::getDelimiter

(

)

Definition at line 335 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$delimiter.

                                  : ?string
    {
        return $this->delimiter;
    }

getEnclosure()

PhpOffice\PhpSpreadsheet\Reader\Csv::getEnclosure

(

)

Definition at line 347 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$enclosure.

                                  : string
    {
        return $this->enclosure;
    }

getEscapeCharacter()

PhpOffice\PhpSpreadsheet\Reader\Csv::getEscapeCharacter

(

)

Definition at line 393 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$escapeCharacter.

                                        : string
    {
        return $this->escapeCharacter;
    }

getFallbackEncoding()

PhpOffice\PhpSpreadsheet\Reader\Csv::getFallbackEncoding

(

)

Definition at line 133 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$fallbackEncoding.

                                         : string
    {
        return $this->fallbackEncoding;
    }

getInputEncoding()

PhpOffice\PhpSpreadsheet\Reader\Csv::getInputEncoding

(

)

Definition at line 121 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$inputEncoding.

                                      : string
    {
        return $this->inputEncoding;
    }

getSheetIndex()

PhpOffice\PhpSpreadsheet\Reader\Csv::getSheetIndex

(

)

Definition at line 362 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$sheetIndex.

                                   : int
    {
        return $this->sheetIndex;
    }

guessEncoding()

static PhpOffice\PhpSpreadsheet\Reader\Csv::guessEncoding ( string  $filename, string  $dflt = self::DEFAULT_FALLBACK_ENCODING  )

static

Definition at line 496 of file Csv.php.

                                                                                                        : string
    {
        $encoding = self::guessEncodingBom($filename);
        if ($encoding === '') {
            $encoding = self::guessEncodingNoBom($filename);
        }

        return ($encoding === '') ? $dflt : $encoding;
    }

guessEncodingBom()

static PhpOffice\PhpSpreadsheet\Reader\Csv::guessEncodingBom ( string  $filename )

staticprivate

Definition at line 481 of file Csv.php.

                                                              : string
    {
        $encoding = '';
        $first4 = file_get_contents($filename, false, null, 0, 4);
        if ($first4 !== false) {
            self::guessEncodingTestBom($encoding, $first4, self::UTF8_BOM, 'UTF-8');
            self::guessEncodingTestBom($encoding, $first4, self::UTF16BE_BOM, 'UTF-16BE');
            self::guessEncodingTestBom($encoding, $first4, self::UTF32BE_BOM, 'UTF-32BE');
            self::guessEncodingTestBom($encoding, $first4, self::UTF32LE_BOM, 'UTF-32LE');
            self::guessEncodingTestBom($encoding, $first4, self::UTF16LE_BOM, 'UTF-16LE');
        }

        return $encoding;
    }

guessEncodingNoBom()

static PhpOffice\PhpSpreadsheet\Reader\Csv::guessEncodingNoBom ( string  $filename )

staticprivate

Definition at line 457 of file Csv.php.

                                                                : string
    {
        $encoding = '';
        $contents = file_get_contents($filename);
        self::guessEncodingTestNoBom($encoding, $contents, self::UTF32BE_LF, 'UTF-32BE');
        self::guessEncodingTestNoBom($encoding, $contents, self::UTF32LE_LF, 'UTF-32LE');
        self::guessEncodingTestNoBom($encoding, $contents, self::UTF16BE_LF, 'UTF-16BE');
        self::guessEncodingTestNoBom($encoding, $contents, self::UTF16LE_LF, 'UTF-16LE');
        if ($encoding === '' && preg_match('//u', $contents) === 1) {
            $encoding = 'UTF-8';
        }

        return $encoding;
    }

guessEncodingTestBom()

static PhpOffice\PhpSpreadsheet\Reader\Csv::guessEncodingTestBom ( string &  $encoding, string  $first4, string  $compare, string  $setEncoding  )

staticprivate

Definition at line 472 of file Csv.php.

                                                                                                                         : void
    {
        if ($encoding === '') {
            if ($compare === substr($first4, 0, strlen($compare))) {
                $encoding = $setEncoding;
            }
        }
    }

guessEncodingTestNoBom()

static PhpOffice\PhpSpreadsheet\Reader\Csv::guessEncodingTestNoBom ( string &  $encoding, string &  $contents, string  $compare, string  $setEncoding  )

staticprivate

Definition at line 447 of file Csv.php.

                                                                                                                              : void
    {
        if ($encoding === '') {
            $pos = strpos($contents, $compare);
            if ($pos !== false && $pos % strlen($compare) === 0) {
                $encoding = $setEncoding;
            }
        }
    }

inferSeparator()

PhpOffice\PhpSpreadsheet\Reader\Csv::inferSeparator ( )

protected

Infer the separator if it isn't explicitly set in the file or specified by the user.

Definition at line 172 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\skipBOM().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting().

                                       : void
    {
        if ($this->delimiter !== null) {
            return;
        }

        $inferenceEngine = new Delimiter($this->fileHandle, $this->escapeCharacter, $this->enclosure);

        // If number of lines is 0, nothing to infer : fall back to the default
        if ($inferenceEngine->linesCounted() === 0) {
            $this->delimiter = $inferenceEngine->getDefaultDelimiter();
            $this->skipBOM();

            return;
        }

        $this->delimiter = $inferenceEngine->infer();

        // If no delimiter could be detected, fall back to the default
        if ($this->delimiter === null) {
            $this->delimiter = $inferenceEngine->getDefaultDelimiter();
        }

        $this->skipBOM();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listWorksheetInfo()

PhpOffice\PhpSpreadsheet\Reader\Csv::listWorksheetInfo

(

string

$pFilename

)

Return worksheet info (Name, Last Column Letter, Last Column Index, Total Rows, Total Columns).

Definition at line 201 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$fileHandle, PhpOffice\PhpSpreadsheet\Reader\Csv\checkSeparator(), PhpOffice\PhpSpreadsheet\Reader\Csv\inferSeparator(), PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory(), PhpOffice\PhpSpreadsheet\Reader\Csv\skipBOM(), and PhpOffice\PhpSpreadsheet\Cell\Coordinate\stringFromColumnIndex().

                                                        : array
    {
        // Open file
        $this->openFileOrMemory($pFilename);
        $fileHandle = $this->fileHandle;

        // Skip BOM, if any
        $this->skipBOM();
        $this->checkSeparator();
        $this->inferSeparator();

        $worksheetInfo = [];
        $worksheetInfo[0]['worksheetName'] = 'Worksheet';
        $worksheetInfo[0]['lastColumnLetter'] = 'A';
        $worksheetInfo[0]['lastColumnIndex'] = 0;
        $worksheetInfo[0]['totalRows'] = 0;
        $worksheetInfo[0]['totalColumns'] = 0;

        // Loop through each line of the file in turn
        $rowData = fgetcsv($fileHandle, 0, $this->delimiter ?? '', $this->enclosure, $this->escapeCharacter);
        while (is_array($rowData)) {
            ++$worksheetInfo[0]['totalRows'];
            $worksheetInfo[0]['lastColumnIndex'] = max($worksheetInfo[0]['lastColumnIndex'], count($rowData) - 1);
            $rowData = fgetcsv($fileHandle, 0, $this->delimiter ?? '', $this->enclosure, $this->escapeCharacter);
        }

        $worksheetInfo[0]['lastColumnLetter'] = Coordinate::stringFromColumnIndex($worksheetInfo[0]['lastColumnIndex'] + 1);
        $worksheetInfo[0]['totalColumns'] = $worksheetInfo[0]['lastColumnIndex'] + 1;

        // Close file
        fclose($fileHandle);

        return $worksheetInfo;
    }

Here is the call graph for this function:

load()

PhpOffice\PhpSpreadsheet\Reader\Csv::load

(

$pFilename

)

Loads Spreadsheet from file.

Parameters

string

$pFilename

Returns

Spreadsheet

Implements PhpOffice\PhpSpreadsheet\Reader\IReader.

Definition at line 243 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting().

    {
        // Create new Spreadsheet
        $spreadsheet = new Spreadsheet();

        // Load into this instance
        return $this->loadIntoExisting($pFilename, $spreadsheet);
    }

Here is the call graph for this function:

loadIntoExisting()

PhpOffice\PhpSpreadsheet\Reader\Csv::loadIntoExisting	(	string	$pFilename,
		Spreadsheet	$spreadsheet
	)

Loads PhpSpreadsheet from file into PhpSpreadsheet instance.

Definition at line 278 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\BaseReader\$fileHandle, PhpOffice\PhpSpreadsheet\Reader\Csv\$sheetIndex, PhpOffice\PhpSpreadsheet\Reader\Csv\checkSeparator(), PhpOffice\PhpSpreadsheet\Spreadsheet\createSheet(), PhpOffice\PhpSpreadsheet\Spreadsheet\getSheetCount(), PhpOffice\PhpSpreadsheet\Reader\Csv\inferSeparator(), PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory(), PhpOffice\PhpSpreadsheet\Spreadsheet\setActiveSheetIndex(), and PhpOffice\PhpSpreadsheet\Reader\Csv\skipBOM().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\load().

                                                                                 : Spreadsheet
    {
        $lineEnding = ini_get('auto_detect_line_endings') ?: '0';
        ini_set('auto_detect_line_endings', '1');

        // Open file
        $this->openFileOrMemory($pFilename);
        $fileHandle = $this->fileHandle;

        // Skip BOM, if any
        $this->skipBOM();
        $this->checkSeparator();
        $this->inferSeparator();

        // Create new PhpSpreadsheet object
        while ($spreadsheet->getSheetCount() <= $this->sheetIndex) {
            $spreadsheet->createSheet();
        }
        $sheet = $spreadsheet->setActiveSheetIndex($this->sheetIndex);

        // Set our starting row based on whether we're in contiguous mode or not
        $currentRow = 1;
        $outRow = 0;

        // Loop through each line of the file in turn
        $rowData = fgetcsv($fileHandle, 0, $this->delimiter ?? '', $this->enclosure, $this->escapeCharacter);
        while (is_array($rowData)) {
            $noOutputYet = true;
            $columnLetter = 'A';
            foreach ($rowData as $rowDatum) {
                if ($rowDatum != '' && $this->readFilter->readCell($columnLetter, $currentRow)) {
                    if ($this->contiguous) {
                        if ($noOutputYet) {
                            $noOutputYet = false;
                            ++$outRow;
                        }
                    } else {
                        $outRow = $currentRow;
                    }
                    // Set cell value
                    $sheet->getCell($columnLetter . $outRow)->setValue($rowDatum);
                }
                ++$columnLetter;
            }
            $rowData = fgetcsv($fileHandle, 0, $this->delimiter ?? '', $this->enclosure, $this->escapeCharacter);
            ++$currentRow;
        }

        // Close file
        fclose($fileHandle);

        ini_set('auto_detect_line_endings', $lineEnding);

        // Return
        return $spreadsheet;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

openFileOrMemory()

PhpOffice\PhpSpreadsheet\Reader\Csv::openFileOrMemory ( string  $pFilename )

private

Definition at line 252 of file Csv.php.

References $data, PhpOffice\PhpSpreadsheet\Reader\Csv\canRead(), PhpOffice\PhpSpreadsheet\Shared\StringHelper\convertEncoding(), PhpOffice\PhpSpreadsheet\Reader\BaseReader\openFile(), and PhpOffice\PhpSpreadsheet\Reader\Csv\skipBOM().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), and PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting().

                                                        : void
    {
        // Open file
        $fhandle = $this->canRead($pFilename);
        if (!$fhandle) {
            throw new Exception($pFilename . ' is an Invalid Spreadsheet file.');
        }
        if ($this->inputEncoding === self::GUESS_ENCODING) {
            $this->inputEncoding = self::guessEncoding($pFilename, $this->fallbackEncoding);
        }
        $this->openFile($pFilename);
        if ($this->inputEncoding !== 'UTF-8') {
            fclose($this->fileHandle);
            $entireFile = file_get_contents($pFilename);
            $this->fileHandle = fopen('php://memory', 'r+b');
            if ($this->fileHandle !== false && $entireFile !== false) {
                $data = StringHelper::convertEncoding($entireFile, 'UTF-8', $this->inputEncoding);
                fwrite($this->fileHandle, $data);
                $this->skipBOM();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setConstructorCallback()

static PhpOffice\PhpSpreadsheet\Reader\Csv::setConstructorCallback ( ?callable  $callback )

static

Set a callback to change the defaults.

The callback must accept the Csv Reader object as the first parameter, and it should return void.

Definition at line 104 of file Csv.php.

                                                                      : void
    {
        self::$constructorCallback = $callback;
    }

setContiguous()

PhpOffice\PhpSpreadsheet\Reader\Csv::setContiguous

(

bool

$contiguous

)

Definition at line 374 of file Csv.php.

                                                   : self
    {
        $this->contiguous = (bool) $contiguous;

        return $this;
    }

setDelimiter()

PhpOffice\PhpSpreadsheet\Reader\Csv::setDelimiter

(

string

$delimiter

)

Definition at line 340 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$delimiter.

                                                   : self
    {
        $this->delimiter = $delimiter;

        return $this;
    }

setEnclosure()

PhpOffice\PhpSpreadsheet\Reader\Csv::setEnclosure

(

string

$enclosure

)

Definition at line 352 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$enclosure.

                                                   : self
    {
        if ($enclosure == '') {
            $enclosure = '"';
        }
        $this->enclosure = $enclosure;

        return $this;
    }

setEscapeCharacter()

PhpOffice\PhpSpreadsheet\Reader\Csv::setEscapeCharacter

(

string

$escapeCharacter

)

Definition at line 386 of file Csv.php.

References PhpOffice\PhpSpreadsheet\Reader\Csv\$escapeCharacter.

                                                               : self
    {
        $this->escapeCharacter = $escapeCharacter;

        return $this;
    }

setFallbackEncoding()

PhpOffice\PhpSpreadsheet\Reader\Csv::setFallbackEncoding

(

string

$pValue

)

Definition at line 126 of file Csv.php.

                                                       : self
    {
        $this->fallbackEncoding = $pValue;

        return $this;
    }

setInputEncoding()

PhpOffice\PhpSpreadsheet\Reader\Csv::setInputEncoding

(

string

$pValue

)

Definition at line 114 of file Csv.php.

                                                    : self
    {
        $this->inputEncoding = $pValue;

        return $this;
    }

setSheetIndex()

PhpOffice\PhpSpreadsheet\Reader\Csv::setSheetIndex

(

int

$pValue

)

Definition at line 367 of file Csv.php.

                                              : self
    {
        $this->sheetIndex = $pValue;

        return $this;
    }

skipBOM()

PhpOffice\PhpSpreadsheet\Reader\Csv::skipBOM ( )

protected

Move filepointer past any BOM marker.

Definition at line 141 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\checkSeparator(), PhpOffice\PhpSpreadsheet\Reader\Csv\inferSeparator(), PhpOffice\PhpSpreadsheet\Reader\Csv\listWorksheetInfo(), PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting(), and PhpOffice\PhpSpreadsheet\Reader\Csv\openFileOrMemory().

                                : void
    {
        rewind($this->fileHandle);

        if (fgets($this->fileHandle, self::UTF8_BOM_LEN + 1) !== self::UTF8_BOM) {
            rewind($this->fileHandle);
        }
    }

Here is the caller graph for this function:

Field Documentation

$constructorCallback

PhpOffice\PhpSpreadsheet\Reader\Csv::$constructorCallback

staticprivate

Definition at line 84 of file Csv.php.

$contiguous

PhpOffice\PhpSpreadsheet\Reader\Csv::$contiguous = false

private

Definition at line 70 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getContiguous().

$delimiter

PhpOffice\PhpSpreadsheet\Reader\Csv::$delimiter

private

Definition at line 49 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getDelimiter(), and PhpOffice\PhpSpreadsheet\Reader\Csv\setDelimiter().

$enclosure

PhpOffice\PhpSpreadsheet\Reader\Csv::$enclosure = '"'

private

Definition at line 56 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getEnclosure(), and PhpOffice\PhpSpreadsheet\Reader\Csv\setEnclosure().

$escapeCharacter

PhpOffice\PhpSpreadsheet\Reader\Csv::$escapeCharacter = '\\'

private

Definition at line 77 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getEscapeCharacter(), and PhpOffice\PhpSpreadsheet\Reader\Csv\setEscapeCharacter().

$fallbackEncoding

PhpOffice\PhpSpreadsheet\Reader\Csv::$fallbackEncoding = self::DEFAULT_FALLBACK_ENCODING

private

Definition at line 42 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getFallbackEncoding().

$inputEncoding

PhpOffice\PhpSpreadsheet\Reader\Csv::$inputEncoding = 'UTF-8'

private

Definition at line 35 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getInputEncoding().

$sheetIndex

PhpOffice\PhpSpreadsheet\Reader\Csv::$sheetIndex = 0

private

Definition at line 63 of file Csv.php.

Referenced by PhpOffice\PhpSpreadsheet\Reader\Csv\getSheetIndex(), and PhpOffice\PhpSpreadsheet\Reader\Csv\loadIntoExisting().

DEFAULT_FALLBACK_ENCODING

const PhpOffice\PhpSpreadsheet\Reader\Csv::DEFAULT_FALLBACK_ENCODING = 'CP1252'

Definition at line 13 of file Csv.php.

GUESS_ENCODING

const PhpOffice\PhpSpreadsheet\Reader\Csv::GUESS_ENCODING = 'guess'

Definition at line 14 of file Csv.php.

UTF16BE_BOM

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16BE_BOM = "\xfe\xff"

Definition at line 17 of file Csv.php.

UTF16BE_BOM_LEN

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16BE_BOM_LEN = 2

Definition at line 18 of file Csv.php.

UTF16BE_LF

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16BE_LF = "\x00\x0a"

Definition at line 19 of file Csv.php.

UTF16LE_BOM

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16LE_BOM = "\xff\xfe"

Definition at line 20 of file Csv.php.

UTF16LE_BOM_LEN

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16LE_BOM_LEN = 2

Definition at line 21 of file Csv.php.

UTF16LE_LF

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF16LE_LF = "\x0a\x00"

Definition at line 22 of file Csv.php.

UTF32BE_BOM

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32BE_BOM = "\x00\x00\xfe\xff"

Definition at line 23 of file Csv.php.

UTF32BE_BOM_LEN

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32BE_BOM_LEN = 4

Definition at line 24 of file Csv.php.

UTF32BE_LF

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32BE_LF = "\x00\x00\x00\x0a"

Definition at line 25 of file Csv.php.

UTF32LE_BOM

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32LE_BOM = "\xff\xfe\x00\x00"

Definition at line 26 of file Csv.php.

UTF32LE_BOM_LEN

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32LE_BOM_LEN = 4

Definition at line 27 of file Csv.php.

UTF32LE_LF

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF32LE_LF = "\x0a\x00\x00\x00"

Definition at line 28 of file Csv.php.

UTF8_BOM

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF8_BOM = "\xEF\xBB\xBF"

Definition at line 15 of file Csv.php.

UTF8_BOM_LEN

const PhpOffice\PhpSpreadsheet\Reader\Csv::UTF8_BOM_LEN = 3

Definition at line 16 of file Csv.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Reader/Csv.php