[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/lib/spout/src/Spout/Reader/CSV/ -> RowIterator.php (summary)

(no description)

File Size: 236 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

RowIterator:: (11 methods):
  __construct()
  rewind()
  rewindAndSkipBom()
  valid()
  next()
  getNextUTF8EncodedRow()
  getEncodedEOLDelimiter()
  isEmptyLine()
  current()
  key()
  end()


Class: RowIterator  - X-Ref

Class RowIterator
Iterate over CSV rows.

__construct($filePointer, $fieldDelimiter, $fieldEnclosure, $encoding, $endOfLineDelimiter, $globalFunctionsHelper)   X-Ref

param: resource $filePointer Pointer to the CSV file to read
param: string $fieldDelimiter Character that delimits fields
param: string $fieldEnclosure Character that enclose fields
param: string $encoding Encoding of the CSV file to be read
param: \Box\Spout\Common\Helper\GlobalFunctionsHelper $globalFunctionsHelper

rewind()   X-Ref
Rewind the Iterator to the first element

return: void

rewindAndSkipBom()   X-Ref
This rewinds and skips the BOM if inserted at the beginning of the file
by moving the file pointer after it, so that it is not read.

return: void

valid()   X-Ref
Checks if current position is valid

return: boolean

next()   X-Ref
Move forward to next element. Empty rows are skipped.

return: void

getNextUTF8EncodedRow()   X-Ref
Returns the next row, converted if necessary to UTF-8.
As fgetcsv() does not manage correctly encoding for non UTF-8 data,
we remove manually whitespace with ltrim or rtrim (depending on the order of the bytes)

return: array|false The row for the current file pointer, encoded in UTF-8 or FALSE if nothing to read

getEncodedEOLDelimiter()   X-Ref
Returns the end of line delimiter, encoded using the same encoding as the CSV.
The return value is cached.

return: string

isEmptyLine($lineData)   X-Ref

param: array $lineData Array containing the cells value for the line
return: bool Whether the given line is empty

current()   X-Ref
Return the current element from the buffer

return: array|null

key()   X-Ref
Return the key of the current element

return: int

end()   X-Ref
Cleans up what was created to iterate over the object.

return: void



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1