Interface Swift_CharacterReader

Analyzes characters for a specific character set.

Direct known implementers

Swift_CharacterReader_GenericFixedWidthReader, Swift_CharacterReader_UsAsciiReader, Swift_CharacterReader_Utf8Reader

Package: Swift\Encoder
Author: Chris Corbyn
Author: Xavier De Cock <xdecock@gmail.com>
Located at vendors/swiftmailer/lib/classes/Swift/CharacterReader.php

Methods summary

`public integer`	# `getCharPositions( string $string, integer $startOffset, array & $currentMap, mixed & $ignoredChars )` Returns the complete charactermap Returns the complete charactermap Parameters `$string` `string` $string `$startOffset` `integer` $startOffset `$currentMap` `array` $currentMap `$ignoredChars` `mixed` $ignoredChars Returns `integer`
`public integer`	# `getMapType( )` Returns mapType Returns mapType Returns `integer` mapType
`public integer`	# `validateByteSequence( int[] $bytes, mixed $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. 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 `$bytes` `int[]` $bytes `$size` Returns `integer`
`public integer`	# `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. 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. Returns `integer`

Magic methods summary

Constants summary

`integer`	`MAP_TYPE_INVALID`	`0x01`	#
`integer`	`MAP_TYPE_FIXED_LEN`	`0x02`	#
`integer`	`MAP_TYPE_POSITIONS`	`0x03`	#