PHP Class Swift_Encoder_QpEncoder, Halite

Possibly the most accurate RFC 2045 QP implementation found in PHP.
Author: Chris Corbyn
Inheritance: implements Swift_Encoder
Afficher le fichier Open project: HaliteChallenge/Halite Class Usage Examples

Protected Properties

Свойство Type Description
$_charStream Swift_CharacterStream The CharacterStream used for reading characters (as opposed to bytes).
$_filter Swift_StreamFilter A filter used if input should be canonicalized.
$_qpMap string[] Pre-computed QP for HUGE optimization.
$_safeMap string[] A map of non-encoded ascii characters.
$_safeMapShare

Méthodes publiques

Méthode Description
__clone ( ) Make a deep copy of object.
__construct ( Swift_CharacterStream $charStream, Swift_StreamFilter $filter = null ) Creates a new QpEncoder for the given CharacterStream.
__sleep ( )
__wakeup ( )
charsetChanged ( string $charset ) Updates the charset used.
encodeString ( string $string, $firstLineOffset, $maxLineLength ) : string Takes an unencoded string and produces a QP encoded string from it.

Méthodes protégées

Méthode Description
_encodeByteSequence ( array $bytes, integer &$size ) : string Encode the given byte array into a verbatim QP form.
_nextSequence ( integer $size = 4 ) : integer[] Get the next sequence of bytes to read from the char stream.
_standardize ( string $string ) : string Make sure CRLF is correct and HT/SPACE are in valid places.
getSafeMapShareId ( )
initSafeMap ( )

Method Details

__clone() public méthode

Make a deep copy of object.
public __clone ( )

__construct() public méthode

Creates a new QpEncoder for the given CharacterStream.
public __construct ( Swift_CharacterStream $charStream, Swift_StreamFilter $filter = null )
$charStream Swift_CharacterStream to use for reading characters
$filter Swift_StreamFilter if input should be canonicalized

__sleep() public méthode

public __sleep ( )

__wakeup() public méthode

public __wakeup ( )

_encodeByteSequence() protected méthode

Encode the given byte array into a verbatim QP form.
protected _encodeByteSequence ( array $bytes, integer &$size ) : string
$bytes array
$size integer
Résultat string

_nextSequence() protected méthode

Get the next sequence of bytes to read from the char stream.
protected _nextSequence ( integer $size = 4 ) : integer[]
$size integer number of bytes to read
Résultat integer[]

_standardize() protected méthode

Make sure CRLF is correct and HT/SPACE are in valid places.
protected _standardize ( string $string ) : string
$string string
Résultat string

charsetChanged() public méthode

Updates the charset used.
public charsetChanged ( string $charset )
$charset string

encodeString() public méthode

QP encoded strings have a maximum line length of 76 characters. If the first line needs to be shorter, indicate the difference with $firstLineOffset.
public encodeString ( string $string, $firstLineOffset, $maxLineLength ) : string
$string string to encode
Résultat string

getSafeMapShareId() protected méthode

protected getSafeMapShareId ( )

initSafeMap() protected méthode

protected initSafeMap ( )

Property Details

$_charStream protected_oe property

The CharacterStream used for reading characters (as opposed to bytes).
protected Swift_CharacterStream $_charStream
Résultat Swift_CharacterStream

$_filter protected_oe property

A filter used if input should be canonicalized.
protected Swift_StreamFilter $_filter
Résultat Swift_StreamFilter

$_qpMap protected_oe static_oe property

Pre-computed QP for HUGE optimization.
protected static string[] $_qpMap
Résultat string[]

$_safeMap protected_oe property

A map of non-encoded ascii characters.
protected string[] $_safeMap
Résultat string[]

$_safeMapShare protected_oe static_oe property

protected static $_safeMapShare