API Documentation
\

\Horde_Xml_Wbxml_Decoder

From Binary XML Content Format Specification Version 1.3, 25 July 2001 found at http://www.wapforum.org

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
getCharsetStr()
setCharset()
getVersion()
setVersion()
getOutput()
getOutputSize()
startElement()
endElement()
characters()
opaque()
setOpaqueHandler()
removeOpaqueHandler()
createSubHandler()
setContentHandler()
getByte()
decodeToString()
decode()
getVersionNumber()
getDocumentPublicIdentifier()
getDocumentPublicIdentifierImpl()
getCharset()
retrieveStringTable()
getStringTableEntry()
parseTag()
endTag()
getAttributes()
startGetAttributes()
stopGetAttributes()
getCurrentURI()
writeString()
getTag()
getAttribute()
switchElementCodePage()
switchAttributeCodePage()
entity()
termstr()
No public properties found
No constants found
_decode()
$_currentUri
$_output
$_opaqueHandler
$_charset
$_wbxmlVersion
$_dpi
$_stringTable
$_ch
$_tagDTD
$_prevAttributeDTD
$_attributeDTD
$_tagStack
$_isAttribute
$_isData
$_error
$_dtdManager
$_strpos
N/A
No private methods found
No private properties found
N/A

Properties

$_currentUri

$_currentUri :

Type

$_output

$_output :

Type

$_opaqueHandler

$_opaqueHandler :

Type

$_charset

$_charset :

Charset.

Type

$_wbxmlVersion

$_wbxmlVersion :

WBXML Version.

1, 2, or 3 supported

Type

$_dpi

$_dpi :

Document Public Identifier type 1 mb_u_int32 well known type 2 string table from spec but converted into a string.

Document Public Identifier Used with dpiType.

Type

$_stringTable

$_stringTable :

String table as defined in 5.7

Type

$_ch

$_ch :

Content handler.

Currently just outputs raw XML.

Type

$_tagDTD

$_tagDTD :

Type

$_prevAttributeDTD

$_prevAttributeDTD :

Type

$_attributeDTD

$_attributeDTD :

Type

$_tagStack

$_tagStack :

State variables.

Type

$_isAttribute

$_isAttribute :

Type

$_isData

$_isData :

Type

$_error

$_error :

Type

$_strpos

$_strpos : integer

The string position.

Type

integer

Methods

__construct()

__construct()

Constructor.

getCharsetStr()

getCharsetStr()

setCharset()

setCharset(  $cs)

Parameters

$cs

getVersion()

getVersion()

setVersion()

setVersion(  $v)

Parameters

$v

getOutput()

getOutput()

getOutputSize()

getOutputSize()

startElement()

startElement(  $uri,   $element,   $attrs = array())

Parameters

$uri
$element
$attrs

endElement()

endElement(  $uri,   $element)

Parameters

$uri
$element

characters()

characters(  $str)

Parameters

$str

opaque()

opaque(  $o)

Parameters

$o

setOpaqueHandler()

setOpaqueHandler(  $opaqueHandler)

Parameters

$opaqueHandler

removeOpaqueHandler()

removeOpaqueHandler()

createSubHandler()

createSubHandler()

setContentHandler()

setContentHandler(\Horde_Xml_Wbxml_ContentHandler  $ch)

Sets the contentHandler that will receive the output of the decoding.

Parameters

\Horde_Xml_Wbxml_ContentHandler $ch

The contentHandler

getByte()

getByte(string  $input)

Return one byte from the input stream.

Parameters

string $input

The WBXML input string.

decodeToString()

decodeToString(string  $wbxml) : string

Takes a WBXML input document and returns decoded XML.

However the preferred and more effecient method is to use decode() rather than decodeToString() and have an appropriate contentHandler deal with the decoded data.

Parameters

string $wbxml

The WBXML document to decode.

Throws

\Horde_Xml_Wbxml_Exception

Returns

string —

The decoded XML document.

decode()

decode(string  $wbxml)

Takes a WBXML input document and decodes it.

Decoding result is directly passed to the contentHandler. A contenthandler must be set using setContentHandler prior to invocation of this method

Parameters

string $wbxml

The WBXML document to decode.

Throws

\Horde_Xml_Wbxml_Exception

getVersionNumber()

getVersionNumber(  $input)

Parameters

$input

getDocumentPublicIdentifier()

getDocumentPublicIdentifier(  $input)

Parameters

$input

getDocumentPublicIdentifierImpl()

getDocumentPublicIdentifierImpl(  $dpiType,   $dpiNumber)

Parameters

$dpiType
$dpiNumber

getCharset()

getCharset(  $input)

Returns the character encoding. Only default character encodings from J2SE are supported. From http://www.iana.org/assignments/character-sets and http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html

Parameters

$input

retrieveStringTable()

retrieveStringTable(  $input)

Retrieves the string table.

The string table consists of an mb_u_int32 length and then length bytes forming the table. References to the string table refer to the starting position of the (null terminated) string in this table.

Parameters

$input

getStringTableEntry()

getStringTableEntry(  $index)

Parameters

$index

parseTag()

parseTag(  $input,   $tag,   $hasAttributes,   $hasContent)

Parameters

$input
$tag
$hasAttributes
$hasContent

endTag()

endTag()

getAttributes()

getAttributes(  $input)

Parameters

$input

startGetAttributes()

startGetAttributes()

stopGetAttributes()

stopGetAttributes()

getCurrentURI()

getCurrentURI()

writeString()

writeString(  $str)

Parameters

$str

getTag()

getTag(  $tag)

Parameters

$tag

getAttribute()

getAttribute(  $attribute)

Parameters

$attribute

switchElementCodePage()

switchElementCodePage(  $codePage)

Parameters

$codePage

switchAttributeCodePage()

switchAttributeCodePage(  $codePage)

Parameters

$codePage

entity()

entity(  $entity)

Return the hex version of the base 10 $entity.

Parameters

$entity

termstr()

termstr(  $input)

Reads a null terminated string.

Parameters

$input

_decode()

_decode(  $input)

Parameters

$input