## Class Swift_CharacterReader_GenericFixedWidthReader

(line 20)

## Description

Located in File: /vendors/swiftMailer/classes/Swift/CharacterReader/GenericFixedWidthReader.php

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

- author: - Chris Corbyn
- author: - Xavier De Cock <xdecock@gmail.com>

## Class Variables

Summary:

## Class Constants

Summary:

## Method Detail

Summary:
Swift_CharacterReader_GenericFixedWidthReader __construct (int $width)
$int getCharPositions (string $string, int $startOffset, &$currentMap, &$ignoredChars, array $currentMap, mixed $ignoredChars)
int getInitialByteSize ()
void getMapType ()
int validateByteSequence (string $bytes, $size)

#### Constructor __construct (line 35)

#### Swift_CharacterReader_GenericFixedWidthReader __construct( int $width)

##### Creates a new GenericFixedWidthReader using $width bytes per character.

#### Parameters

- int $width:

#### Info

- access - public

#### Method getCharPositions (line 49)

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

Implementation of:

Swift_CharacterReader::getCharPositions()
  Returns the complete charactermap

##### Returns the complete charactermap

#### Parameters

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

#### Info

- access - public

#### Method getInitialByteSize (line 91)

#### int getInitialByteSize( )

Implementation of:

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

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

#### Info

- access - public

#### Method getMapType (line 64)

#### void getMapType( )

Implementation of:

Swift_CharacterReader::getMapType()
  Returns mapType

##### Returns mapType

#### Info

- access - public

#### Method validateByteSequence (line 78)

#### int validateByteSequence( string $bytes, $size)

Implementation of:

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

##### 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:
- $size:

#### Info

- access - public

## Inherited Variables

### Inherited Class Variable Summary

## Inherited Methods

### Inherited Method Summary

Documentation generated on Fri, 12 Nov 2010 20:45:21 +0000 by phpDocumentor 1.4.3