PHP Class Horde_ActiveSync_Wbxml_Decoder, horde

Author: Michael J Rubinsky ([email protected])
Inheritance: extends Horde_ActiveSync_Wbxml
Mostra file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$charsetid
$publicid
$publicstringid
$stringtable
$version integer Store the wbxml version value. Used to verify we have a valid wbxml input stream.

Protected Properties

Property Type Description
$_attrcp
$_buffer stream Temporary string buffer
$_isWbxml boolean Flag to indicate we have a valid wbxml input stream
$_lastStartElement array Cache the last successfully fetched start tag array. Used to be able to easily detected emtpy nodes after the element was already fetched.
$_readHeader
$_ungetbuffer

Public Methods

Method Description
_ungetElement ( array $element ) : void Unget the specified element from the stream. Places the element into the unget buffer.
getElement ( ) : array | boolean Returns either start, content or end, and auto-concatenates successive content.
getElementContent ( ) : mixed Get the element contents
getElementEndTag ( ) : array | boolean Get the next tag, which is assumed to be an end tag.
getElementStartTag ( string $tag ) : array | boolean 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 | boolean Returns the last element array fetched using getElementStartTag()
getToken ( ) : array Get the next [start | content | end] tag.
isEmptyElement ( array $el ) : boolean Returns whether or not the passed in element array represents an empty tag.
isWbxml ( ) : boolean Check that the input stream contains wbxml. Basically looks for a valid WBXML_VERSION header. self::readWbxmlHeader MUST have been called already.
peek ( ) : array Peek at the next element in the stream.
readWbxmlHeader ( ) Start reading the wbxml stream, pulling off the initial header and populate the properties.

Protected Methods

Method Description
_getAttributes ( ) : mixed Get the element attributes
_getByte ( ) : string Fetch a single byte from the stream.
_getMBUInt ( ) : integer Get an MBU integer
_getMapping ( integer $cp, integer $id ) : mixed Get a dtd mapping
_getOpaque ( integer $len ) : 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 ( integer $id ) : 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.
_getTempStream ( ) : stream Return the temporary buffer stream.
_getTermStr ( ) : string Get a null terminated string from the stream.
_getToken ( ) : array Get the next start tag, content or end tag
_logToken ( $el ) : void Log the token.
_readVersion ( ) Read the Wbxml version header byte, and buffer the input incase we need the full stream later.
_splitAttribute ( string $attr ) : array Parses an attribute string

Method Details

_getAttributes() protected method

Get the element attributes
protected _getAttributes ( ) : mixed
return mixed The value of the element's attributes.

_getByte() protected method

Fetch a single byte from the stream.
protected _getByte ( ) : string
return string The single byte.

_getMBUInt() protected method

Get an MBU integer
protected _getMBUInt ( ) : integer
return integer

_getMapping() protected method

Get a dtd mapping
protected _getMapping ( integer $cp, integer $id ) : mixed
$cp integer The codepage to use.
$id integer The property.
return mixed The mapped value.

_getOpaque() protected method

Get an opaque value from the stream of the specified length.
protected _getOpaque ( integer $len ) : string
$len integer The length of the data to fetch.
return string A string of bytes representing the opaque value.

_getStringTable() protected method

Fetch the string table. Don't think we use the results anywhere though.
protected _getStringTable ( ) : string
return string The string table.

_getStringTableEntry() protected 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.
protected _getStringTableEntry ( integer $id ) : string
$id integer The entry to return??
return string

_getTempStream() protected method

Return the temporary buffer stream.
protected _getTempStream ( ) : stream
return stream

_getTermStr() protected method

Get a null terminated string from the stream.
protected _getTermStr ( ) : string
return string The string

_getToken() protected method

Get the next start tag, content or end tag
protected _getToken ( ) : array
return array The element array.

_logToken() protected method

Log the token.
protected _logToken ( $el ) : void
return void

_readVersion() protected method

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

_splitAttribute() protected method

Parses an attribute string
protected _splitAttribute ( string $attr ) : array
$attr string The raw attribute value.
return array The attribute hash

_ungetElement() public method

Unget the specified element from the stream. Places the element into the unget buffer.
public _ungetElement ( array $element ) : void
$element array The element array to unget.
return void

getElement() public method

Returns either start, content or end, and auto-concatenates successive content.
public getElement ( ) : array | boolean
return array | boolean The element structure or false on failure.

getElementContent() public method

Get the element contents
public getElementContent ( ) : mixed
return mixed The content of the current element | false on failure.

getElementEndTag() public method

Get the next tag, which is assumed to be an end tag.
public getElementEndTag ( ) : array | boolean
return array | boolean The element array | false on failure.

getElementStartTag() public method

Get the next tag, which is assumed to be a start tag.
public getElementStartTag ( string $tag ) : array | boolean
$tag string The element that this should be a start tag for.
return array | boolean The start tag array | false on failure.

getFullInputStream() public method

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.
public getFullInputStream ( ) : resource
return resource

getLastStartElement() public method

Returns the last element array fetched using getElementStartTag()
public getLastStartElement ( ) : array | boolean
return array | boolean The element array, or false if none available.

getToken() public method

Get the next [start | content | end] tag.
public getToken ( ) : array
return array The next, complete, token array.

isEmptyElement() public method

Returns whether or not the passed in element array represents an empty tag.
public isEmptyElement ( array $el ) : boolean
$el array The element array.
return boolean True if $el is an empty start tag, otherwise false.

isWbxml() public method

Check that the input stream contains wbxml. Basically looks for a valid WBXML_VERSION header. self::readWbxmlHeader MUST have been called already.
public isWbxml ( ) : boolean
return boolean

peek() public method

Peek at the next element in the stream.
public peek ( ) : array
return array The next element in the stream.

readWbxmlHeader() public method

Start reading the wbxml stream, pulling off the initial header and populate the properties.
public readWbxmlHeader ( )

Property Details

$_attrcp protected_oe property

protected $_attrcp

$_buffer protected_oe property

Temporary string buffer
protected stream $_buffer
return stream

$_isWbxml protected_oe property

Flag to indicate we have a valid wbxml input stream
protected bool $_isWbxml
return boolean

$_lastStartElement protected_oe property

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

$_readHeader protected_oe property

protected $_readHeader

$_ungetbuffer protected_oe property

protected $_ungetbuffer

$charsetid public_oe property

public $charsetid

$publicid public_oe property

public $publicid

$publicstringid public_oe property

public $publicstringid

$stringtable public_oe property

public $stringtable

$version public_oe property

Store the wbxml version value. Used to verify we have a valid wbxml input stream.
public int $version
return integer