Swift
[ class tree: Swift ] [ index: Swift ] [ all elements ]

Class: Swift_CharacterReader_GenericFixedWidthReader

Source Location: /vendors/swift/classes/Swift/CharacterReader/GenericFixedWidthReader.php

Class Overview


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


Author(s):

Implements interfaces:

Methods



Class Details

[line 20]
Provides fixed-width byte sizes for reading fixed-width character sets.



Tags:

author:  Xavier De Cock <xdecock@gmail.com>
author:  Chris Corbyn
filesource:  Source Code for this file


[ Top ]


Class Methods


constructor __construct [line 35]

Swift_CharacterReader_GenericFixedWidthReader __construct( int $width)

Creates a new GenericFixedWidthReader using $width bytes per character.



Tags:

access:  public


Parameters:

int   $width  

[ Top ]

method getCharPositions [line 49]

$int getCharPositions( string $string, int $startOffset, &$currentMap, &$ignoredChars, array $currentMap, mixed $ignoredChars)

Returns the complete charactermap



Tags:

access:  public



Implementation of:
Swift_CharacterReader::getCharPositions()
Returns the complete charactermap

Parameters:

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

[ Top ]

method getInitialByteSize [line 91]

int getInitialByteSize( )

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



Tags:

access:  public



Implementation of:
Swift_CharacterReader::getInitialByteSize()
Returns the number of bytes which should be read to start each character.
[ Top ]

method getMapType [line 64]

void getMapType( )

Returns mapType



Tags:

access:  public



Implementation of:
Swift_CharacterReader::getMapType()
Returns mapType
[ Top ]

method validateByteSequence [line 78]

int validateByteSequence( string $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.




Tags:

access:  public



Implementation of:
Swift_CharacterReader::validateByteSequence()
Returns an integer which specifies how many more bytes to read.

Parameters:

string   $bytes  
   $size  

[ Top ]


Documentation generated on Mon, 05 Sep 2011 20:33:26 -0500 by phpDocumentor 1.4.3