Documentation

Horde_ActiveSync_Wbxml_Decoder extends Horde_ActiveSync_Wbxml

in package

• ActiveSync

ActiveSync specific WBXML decoder.

Tags

license

http://www.horde.org/licenses/gpl GPLv2

copyright

2009-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

EN_ATTRIBUTES  = 5

EN_CONTENT  = 3

EN_FLAGS  = 4

EN_FLAGS_ATTRIBUTES  = 2

EN_FLAGS_CONTENT  = 1

EN_TAG  = 2

EN_TYPE  = 1

EN_TYPE_CONTENT  = 3

EN_TYPE_ENDTAG  = 2

EN_TYPE_STARTTAG  = 1

END  = 0x1

ENTITY  = 0x2

EXT_0  = 0xc0

EXT_1  = 0xc1

EXT_2  = 0xc2

EXT_I_0  = 0x40

EXT_I_1  = 0x41

EXT_I_2  = 0x42

EXT_T_0  = 0x80

EXT_T_1  = 0x81

EXT_T_2  = 0x82

LITERAL  = 0x4

LITERAL_A  = 0x84

LITERAL_AC  = 0xc4

LITERAL_C  = 0x44

LOG_DETAILED  = 1

LOG_MAXCONTENT  = 50

LOG_PROTOCOL  = 2

OPAQUE  = 0xc3

PI  = 0x43

STR_I  = 0x3

STR_T  = 0x83

SWITCH_PAGE  = 0x0

WBXML_VERSION  = 0x3

$charsetid  : mixed

$publicid  : mixed

$publicstringid  : mixed

$stringtable  : mixed

$version  : int

Store the wbxml version value. Used to verify we have a valid wbxml input stream.

$_attrcp  : mixed

$_buffer  : stream

Temporary string buffer

$_dtd  : array<string|int, mixed>

The code page definitions for the wbxml encoder/decoders

$_isWbxml  : bool

Flag to indicate we have a valid wbxml input stream

$_lastStartElement  : array<string|int, mixed>

Cache the last successfully fetched start tag array. Used to be able to easily detected emtpy nodes after the element was already fetched.

$_logger  : Horde_Log_Logger

Logger

$_logLevel  : mixed

Logging level.

$_logStack  : array<string|int, mixed>

Used to hold log entries for each tag so we can only output the log entries for the tags that are actually sent (@see $_stack).

$_procid  : int

The current procid

$_readHeader  : mixed

$_stream  : Horde_Stream

Input or Output stream

$_tagcp  : int

Track the codepage for the currently output tag so we know when to switch codepages.

$_ungetbuffer  : mixed

__construct()  : mixed

_ungetElement()  : void

Unget the specified element from the stream. Places the element into the unget buffer.

getElement()  : array<string|int, mixed>|bool

Returns either start, content or end, and auto-concatenates successive content.

getElementContent()  : mixed

Get the element contents

getElementEndTag()  : array<string|int, mixed>|bool

Get the next tag, which is assumed to be an end tag.

getElementStartTag()  : array<string|int, mixed>|bool

Get the next tag, which is assumed to be a start tag.

getFullInputStream()  : resource

Return the full, raw, input stream. Used for things like SendMail request where we don't have wbxml to parse. The calling code is responsible for closing the stream.

getLastStartElement()  : array<string|int, mixed>|bool

Returns the last element array fetched using getElementStartTag()

getStream()  : mixed

getToken()  : array<string|int, mixed>

Get the next [start | content | end] tag.

isEmptyElement()  : bool

Returns whether or not the passed in element array represents an empty tag.

isWbxml()  : bool

Check that the input stream contains wbxml. Basically looks for a valid WBXML_VERSION header. self::readWbxmlHeader MUST have been called already.

peek()  : array<string|int, mixed>

Peek at the next element in the stream.

readWbxmlHeader()  : mixed

Start reading the wbxml stream, pulling off the initial header and populate the properties.

setLogger()  : mixed

Set the logger instance

_getAttributes()  : mixed

Get the element attributes

_getByte()  : string

Fetch a single byte from the stream.

_getMapping()  : mixed

Get a dtd mapping

_getMBUInt()  : int

Get an MBU integer

_getOpaque()  : string

Get an opaque value from the stream of the specified length.

_getStringTable()  : string

Fetch the string table. Don't think we use the results anywhere though.

_getStringTableEntry()  : string

Really don't know for sure what this method is supposed to do, it is called from numerous places in this class, but the original zpush code did not contain this method...so, either it's completely broken, or normal use-cases do not reach the calling code. Either way, it needs to eventually be fixed.

_getTempStream()  : stream

Return the temporary buffer stream.

_getTermStr()  : string

Get a null terminated string from the stream.

_getToken()  : array<string|int, mixed>

Get the next start tag, content or end tag

_logToken()  : void

Log the token.

_readVersion()  : mixed

Read the Wbxml version header byte, and buffer the input incase we need the full stream later.

_splitAttribute()  : array<string|int, mixed>

Parses an attribute string