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

Class: Swift_CharacterReader_GenericFixedWidthReader

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/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 17]
Provides fixed-width byte sizes for reading fixed-width character sets.



Tags:

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


[ Top ]


Class Methods


constructor __construct [line 31]

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 46]

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

Returns the complete character map.



Tags:

access:  public



Implementation of:
Swift_CharacterReader::getCharPositions()
Returns the complete character map.

Parameters:

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

[ Top ]

method getInitialByteSize [line 93]

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 62]

int getMapType( )

Returns the mapType.



Tags:

access:  public



Implementation of:
Swift_CharacterReader::getMapType()
Returns the mapType, see constants.
[ Top ]

method validateByteSequence [line 81]

int validateByteSequence( string $bytes, int $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  
int   $size  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:49:16 +0000 by phpDocumentor 1.4.3