API Documentation
\

\Horde_Xml_Wbxml_Encoder

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()
Horde_Xml_Wbxml_Encoder()
encode()
writeHeader()
writeVersionNumber()
writeDocumentPublicIdentifier()
writeCharset()
writeStringTable()
writeString()
writeNull()
writeTag()
writeAttributes()
writeAttribute()
changecodepage()
No public properties found
No constants found
_addNullByte()
_getBytes()
_splitURI()
_startElement()
_characters()
_endElement()
$_currentUri
$_output
$_opaqueHandler
$_charset
$_wbxmlVersion
$_strings
$_stringTable
$_hasWrittenHeader
$_dtd
$_uris
$_uriNums
$_currentURI
$_subParser
$_subParserStack
$_parser
$_dtdManager
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

$_strings

$_strings :

Type

$_stringTable

$_stringTable :

Type

$_hasWrittenHeader

$_hasWrittenHeader :

Type

$_dtd

$_dtd :

Type

$_uris

$_uris :

Type

$_uriNums

$_uriNums :

Type

$_currentURI

$_currentURI :

Type

$_subParser

$_subParser :

Type

$_subParserStack

$_subParserStack :

Type

$_parser

$_parser : resource

The XML parser.

Type

resource

Methods

__construct()

__construct()

getCharsetStr()

getCharsetStr()

setCharset()

setCharset(  $cs)

Parameters

$cs

getVersion()

getVersion()

setVersion()

setVersion(  $v)

Parameters

$v

getOutput()

getOutput()

Getter for property output.

getOutputSize()

getOutputSize()

startElement()

startElement(  $uri,   $name,   $attributes = array())

Parameters

$uri
$name
$attributes

Throws

\Horde_Xml_Wbxml_Exception

endElement()

endElement(  $uri,   $name)

Parameters

$uri
$name

characters()

characters(  $chars)

Parameters

$chars

opaque()

opaque(  $o)

Parameters

$o

setOpaqueHandler()

setOpaqueHandler(  $opaqueHandler)

Parameters

$opaqueHandler

removeOpaqueHandler()

removeOpaqueHandler()

createSubHandler()

createSubHandler()

Horde_Xml_Wbxml_Encoder()

Horde_Xml_Wbxml_Encoder()

Constructor.

encode()

encode(  $xml)

Take the input $xml and turn it into WBXML. This is _not_ the intended way of using this class. It is derived from Contenthandler and one should use it as a ContentHandler and produce the XML-structure with startElement(), endElement(), and characters().

Parameters

$xml

Throws

\Horde_Xml_Wbxml_Exception

writeHeader()

writeHeader(  $uri)

This will write the correct headers.

Parameters

$uri

Throws

\Horde_Xml_Wbxml_Exception

writeVersionNumber()

writeVersionNumber(  $version)

Parameters

$version

writeDocumentPublicIdentifier()

writeDocumentPublicIdentifier(  $dpiString,   $strings)

Parameters

$dpiString
$strings

writeCharset()

writeCharset(  $charset)

Parameters

$charset

Throws

\Horde_Xml_Wbxml_Exception

writeStringTable()

writeStringTable(  $strings,   $charset,   $stringTable)

Parameters

$strings
$charset
$stringTable

writeString()

writeString(  $str,   $cs)

Parameters

$str
$cs

writeNull()

writeNull(  $charset)

Parameters

$charset

writeTag()

writeTag(  $name,   $attrs,   $hasContent,   $cs)

Parameters

$name
$attrs
$hasContent
$cs

Throws

\Horde_Xml_Wbxml_Exception

writeAttributes()

writeAttributes(  $attrs,   $cs)

Parameters

$attrs
$cs

writeAttribute()

writeAttribute(  $name,   $value,   $cs)

Parameters

$name
$value
$cs

Throws

\Horde_Xml_Wbxml_Exception

changecodepage()

changecodepage(  $uri)

Parameters

$uri

_addNullByte()

_addNullByte(  $bytes)

Parameters

$bytes

_getBytes()

_getBytes(  $string,   $cs)

Parameters

$string
$cs

_splitURI()

_splitURI(  $tag)

Parameters

$tag

_startElement()

_startElement(  $parser,   $tag,   $attributes)

Parameters

$parser
$tag
$attributes

_characters()

_characters(  $parser,   $chars)

Parameters

$parser
$chars

_endElement()

_endElement(  $parser,   $tag)

Parameters

$parser
$tag