Swift_CharacterReader_GenericFixedWidthReader Class Reference

Inheritance diagram for Swift_CharacterReader_GenericFixedWidthReader:

Public Member Functions
	__construct ($width)
	getCharPositions ($string, $startOffset, &$currentMap, &$ignoredChars)
	getMapType ()
	validateByteSequence ($bytes, $size)
	getInitialByteSize ()

Private Attributes
	$_width

Additional Inherited Members
Public Attributes inherited from Swift_CharacterReader
const	MAP_TYPE_INVALID = 0x01
const	MAP_TYPE_FIXED_LEN = 0x02
const	MAP_TYPE_POSITIONS = 0x03

Detailed Description

Provides fixed-width byte sizes for reading fixed-width character sets.

Author

Chris Corbyn

Xavier De Cock xdeco.nosp@m.ck@g.nosp@m.mail..nosp@m.com

Definition at line 17 of file GenericFixedWidthReader.php.

Constructor & Destructor Documentation

__construct

(

$width

)

Creates a new GenericFixedWidthReader using $width bytes per character.

Parameters

int

$width

Definition at line 31 of file GenericFixedWidthReader.php.

Member Function Documentation

getCharPositions	(		$string,
			$startOffset,
		&	$currentMap,
		&	$ignoredChars
	)

Returns the complete character map.

Parameters

string	$string
int	$startOffset
array	$currentMap
mixed	$ignoredChars

Returns

int

Implements Swift_CharacterReader.

Definition at line 46 of file GenericFixedWidthReader.php.

References $_width.

getInitialByteSize

(

)

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

Returns

int

Implements Swift_CharacterReader.

Definition at line 93 of file GenericFixedWidthReader.php.

References $_width.

getMapType

(

)

Returns the mapType.

Returns

int

Implements Swift_CharacterReader.

Definition at line 62 of file GenericFixedWidthReader.php.

validateByteSequence	(		$bytes,
			$size
	)

Returns an integer which specifies how many more bytes to read.

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.

Parameters

string	$bytes
int	$size

Returns

int

Implements Swift_CharacterReader.

Definition at line 81 of file GenericFixedWidthReader.php.

Member Data Documentation

$_width

private

Definition at line 24 of file GenericFixedWidthReader.php.

Referenced by getCharPositions(), and getInitialByteSize().