Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • Csv
          • Filter
          • Reader
          • Writer

Classes

  • EasyCsvReaderAdapter
  • FilteredReader
  • FilteredReaderFactory
  • Reader
  • ReaderFactory

Interfaces

  • ReaderInterface
  • Overview
  • Namespace
  • Class

Class Reader

Interface BaseInterface

Net\Bazzline\Component\Csv\AbstractBase implements Net\Bazzline\Component\Csv\BaseInterface
Extended by Net\Bazzline\Component\Csv\Reader\Reader implements Net\Bazzline\Component\Csv\Reader\ReaderInterface

Direct known subclasses

Net\Bazzline\Component\Csv\Reader\FilteredReader
Namespace: Net\Bazzline\Component\Csv\Reader
Package: Net\Bazzline\Component\Csv
Located at Reader/Reader.php
Methods summary
public array|boolean|string
# __invoke( null $currentLineNumber = null )

Parameters

$currentLineNumber

Returns

array|boolean|string
public
# setDelimiter( string $delimiter )

Parameters

$delimiter

Throws

Net\Bazzline\Component\Csv\InvalidArgumentException

Overrides

Net\Bazzline\Component\Csv\AbstractBase::setDelimiter()

Implementation of

Net\Bazzline\Component\Csv\BaseInterface::setDelimiter()
public
# setEnclosure( string $enclosure )

Parameters

$enclosure

Throws

Net\Bazzline\Component\Csv\InvalidArgumentException

Overrides

Net\Bazzline\Component\Csv\AbstractBase::setEnclosure()

Implementation of

Net\Bazzline\Component\Csv\BaseInterface::setEnclosure()
public
# setEscapeCharacter( string $escapeCharacter )

Parameters

$escapeCharacter

Throws

Net\Bazzline\Component\Csv\InvalidArgumentException

Overrides

Net\Bazzline\Component\Csv\AbstractBase::setEscapeCharacter()

Implementation of

Net\Bazzline\Component\Csv\BaseInterface::setEscapeCharacter()
public mixed
# current( )

(PHP 5 >= 5.0.0)
Return the current element

(PHP 5 >= 5.0.0)
Return the current element

Returns

mixed
Can return any type.

Link

http://php.net/manual/en/iterator.current.php

Implementation of

Iterator::current()
public
# next( )

(PHP 5 >= 5.0.0)
Move forward to next element

(PHP 5 >= 5.0.0)
Move forward to next element

Returns


Any returned value is ignored.

Link

http://php.net/manual/en/iterator.next.php

Implementation of

Iterator::next()
public mixed
# key( )

(PHP 5 >= 5.0.0)
Return the key of the current element

(PHP 5 >= 5.0.0)
Return the key of the current element

Returns

mixed
scalar on success, or null on failure.

Link

http://php.net/manual/en/iterator.key.php

Implementation of

Iterator::key()
public boolean
# valid( )

(PHP 5 >= 5.0.0)
Checks if current position is valid

(PHP 5 >= 5.0.0)
Checks if current position is valid

Returns

boolean

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

Link

http://php.net/manual/en/iterator.valid.php

Implementation of

Iterator::valid()
public
# rewind( )

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

(PHP 5 >= 5.0.0)
Rewind the Iterator to the first element

Returns


Any returned value is ignored.

Link

http://php.net/manual/en/iterator.rewind.php

Implementation of

Iterator::rewind()
public
# disableAddHeadlineToOutput( )

Returns


$this

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::disableAddHeadlineToOutput()
public
# enableAddHeadlineToOutput( )

Returns


$this

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::enableAddHeadlineToOutput()
public
# disableHasHeadline( )

Returns


$this

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::disableHasHeadline()
public
# enableHasHeadline( )

Returns


$this

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::enableHasHeadline()
public false|array
# readHeadline( )

Returns

false|array

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::readHeadline()
public
# setCombine( Net\Bazzline\Component\Toolbox\HashMap\Combine $combine )

Parameters

$combine

Returns


$this

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::setCombine()
public array|boolean|string
# readOne( null|integer $lineNumber = null )

Parameters

$lineNumber
  • if "null", current line number is used

Returns

array|boolean|string

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::readOne()
public array
# readMany( integer $length, null|integer $lineNumberToStartWith = null )

Parameters

$length
$lineNumberToStartWith
  • if "null", current line number is used

Returns

array

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::readMany()
public array
# readAll( )

Returns

array

Implementation of

Net\Bazzline\Component\Csv\Reader\ReaderInterface::readAll()
protected string
# getFileHandlerOpenMode( )

Returns

string
Methods inherited from Net\Bazzline\Component\Csv\AbstractBase
close(), getDelimiter(), getEnclosure(), getEscapeCharacter(), getFileHandler(), getHeadline(), getPath(), hasHeadline(), open(), resetHeadline(), setHeadline(), setPath()
PHP Csv Component by bazzline.net API documentation generated by ApiGen