PHP Класс Horde_ActiveSync_Wbxml_Decoder, horde

Автор: Michael J Rubinsky ([email protected])
Наследование: extends Horde_ActiveSync_Wbxml
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$charsetid
$publicid
$publicstringid
$stringtable
$version integer Store the wbxml version value. Used to verify we have a valid wbxml input stream.

Защищенные свойства (Protected)

Свойство Тип Описание
$_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

Открытые методы

Метод Описание
_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.

Защищенные методы

Метод Описание
_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

Описание методов

_getAttributes() защищенный Метод

Get the element attributes
protected _getAttributes ( ) : mixed
Результат mixed The value of the element's attributes.

_getByte() защищенный Метод

Fetch a single byte from the stream.
protected _getByte ( ) : string
Результат string The single byte.

_getMBUInt() защищенный Метод

Get an MBU integer
protected _getMBUInt ( ) : integer
Результат integer

_getMapping() защищенный Метод

Get a dtd mapping
protected _getMapping ( integer $cp, integer $id ) : mixed
$cp integer The codepage to use.
$id integer The property.
Результат mixed The mapped value.

_getOpaque() защищенный Метод

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.
Результат string A string of bytes representing the opaque value.

_getStringTable() защищенный Метод

Fetch the string table. Don't think we use the results anywhere though.
protected _getStringTable ( ) : string
Результат string The string table.

_getStringTableEntry() защищенный Метод

..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??
Результат string

_getTempStream() защищенный Метод

Return the temporary buffer stream.
protected _getTempStream ( ) : stream
Результат stream

_getTermStr() защищенный Метод

Get a null terminated string from the stream.
protected _getTermStr ( ) : string
Результат string The string

_getToken() защищенный Метод

Get the next start tag, content or end tag
protected _getToken ( ) : array
Результат array The element array.

_logToken() защищенный Метод

Log the token.
protected _logToken ( $el ) : void
Результат void

_readVersion() защищенный Метод

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

_splitAttribute() защищенный Метод

Parses an attribute string
protected _splitAttribute ( string $attr ) : array
$attr string The raw attribute value.
Результат array The attribute hash

_ungetElement() публичный Метод

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.
Результат void

getElement() публичный Метод

Returns either start, content or end, and auto-concatenates successive content.
public getElement ( ) : array | boolean
Результат array | boolean The element structure or false on failure.

getElementContent() публичный Метод

Get the element contents
public getElementContent ( ) : mixed
Результат mixed The content of the current element | false on failure.

getElementEndTag() публичный Метод

Get the next tag, which is assumed to be an end tag.
public getElementEndTag ( ) : array | boolean
Результат array | boolean The element array | false on failure.

getElementStartTag() публичный Метод

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.
Результат array | boolean The start tag array | false on failure.

getFullInputStream() публичный Метод

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
Результат resource

getLastStartElement() публичный Метод

Returns the last element array fetched using getElementStartTag()
public getLastStartElement ( ) : array | boolean
Результат array | boolean The element array, or false if none available.

getToken() публичный Метод

Get the next [start | content | end] tag.
public getToken ( ) : array
Результат array The next, complete, token array.

isEmptyElement() публичный Метод

Returns whether or not the passed in element array represents an empty tag.
public isEmptyElement ( array $el ) : boolean
$el array The element array.
Результат boolean True if $el is an empty start tag, otherwise false.

isWbxml() публичный Метод

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
Результат boolean

peek() публичный Метод

Peek at the next element in the stream.
public peek ( ) : array
Результат array The next element in the stream.

readWbxmlHeader() публичный Метод

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

Описание свойств

$_attrcp защищенное свойство

protected $_attrcp

$_buffer защищенное свойство

Temporary string buffer
protected stream $_buffer
Результат stream

$_isWbxml защищенное свойство

Flag to indicate we have a valid wbxml input stream
protected bool $_isWbxml
Результат boolean

$_lastStartElement защищенное свойство

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
Результат array

$_readHeader защищенное свойство

protected $_readHeader

$_ungetbuffer защищенное свойство

protected $_ungetbuffer

$charsetid публичное свойство

public $charsetid

$publicid публичное свойство

public $publicid

$publicstringid публичное свойство

public $publicstringid

$stringtable публичное свойство

public $stringtable

$version публичное свойство

Store the wbxml version value. Used to verify we have a valid wbxml input stream.
public int $version
Результат integer