PHP Class Swift_CharacterReader_GenericFixedWidthReader, Halite

Author: Chris Corbyn

Author: Xavier De Cock ([email protected])

Inheritance: implements Swift_CharacterReader

Show file Open project: HaliteChallenge/Halite Class Usage Examples

Public Methods

Method	Description
__construct ( integer $width )	Creates a new GenericFixedWidthReader using $width bytes per character.
getCharPositions ( string $string, integer $startOffset, array &$currentMap, mixed &$ignoredChars ) : integer	Returns the complete character map.
getInitialByteSize ( ) : integer	Returns the number of bytes which should be read to start each character.
getMapType ( ) : integer	Returns the mapType.
validateByteSequence ( string $bytes, integer $size ) : integer	Returns an integer which specifies how many more bytes to read.

Method Details

__construct() public method

Creates a new GenericFixedWidthReader using $width bytes per character.

public __construct ( integer $width )
$width	integer

getCharPositions() public method

Returns the complete character map.

public getCharPositions ( string $string, integer $startOffset, array &$currentMap, mixed &$ignoredChars ) : integer
$string	string
$startOffset	integer
$currentMap	array
$ignoredChars	mixed
return	integer

getInitialByteSize() public method

Returns the number of bytes which should be read to start each character.

public getInitialByteSize ( ) : integer
return	integer

getMapType() public method

Returns the mapType.

public getMapType ( ) : integer
return	integer

validateByteSequence() public method

A positive integer indicates the number of more bytes to fetch before invoking this method again. A value of zero means this is already a valid character. A value of -1 means this cannot possibly be a valid character.

public validateByteSequence ( string $bytes, integer $size ) : integer
$bytes	string
$size	integer
return	integer