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

Class: Swift_CharacterReader

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/CharacterReader.php

Interface Overview


Analyzes characters for a specific character set.


Author(s):

Constants

Methods



Class Details

[line 17]
Analyzes characters for a specific character set.



Tags:

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


[ Top ]


Class Methods


method getCharPositions [line 33]

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

Returns the complete character map.



Tags:

access:  public


Parameters:

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

[ Top ]

method getInitialByteSize [line 66]

int getInitialByteSize( )

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

For fixed width character sets this should be the number of octets-per-character. For multibyte character sets this will probably be 1.




Tags:

access:  public


[ Top ]

method getMapType [line 40]

int getMapType( )

Returns the mapType, see constants.



Tags:

access:  public


[ Top ]

method validateByteSequence [line 56]

int validateByteSequence( integer[] $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


Parameters:

integer[]   $bytes  
int   $size  

[ Top ]


Class Constants

MAP_TYPE_FIXED_LEN =  0x02

[line 20]


[ Top ]

MAP_TYPE_INVALID =  0x01

[line 19]


[ Top ]

MAP_TYPE_POSITIONS =  0x03

[line 21]


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:46:11 +0000 by phpDocumentor 1.4.3