API Documentation
\

\Horde_Imap_Client_Tokenize

Tokenization of an IMAP data stream.

NOTE: This class is NOT intended to be accessed outside of this package. There is NO guarantees that the API of this class will not change across versions.

Summary

Methods
Properties
Constants
__construct()
__clone()
__get()
__sleep()
__toString()
add()
addLiteralStream()
flushIterator()
getLiteralLength()
current()
key()
next()
nextStream()
rewind()
valid()
$eos
No constants found
No protected methods found
$_current
$_key
$_level
$_literals
$_literalStream
$_nextModify
$_stream
N/A
No private methods found
No private properties found
N/A

Properties

$eos

$eos : boolean

Has the end of the stream been reached?

Type

boolean

$_current

$_current : mixed

Current data.

Type

mixed

$_key

$_key : integer

Current key.

Type

integer

$_level

$_level : integer

Sublevel.

Type

integer

$_literals

$_literals : array

Array of literal stream objects.

Type

array

$_literalStream

$_literalStream : boolean

Return Horde_Stream object for literal tokens?

Type

boolean

$_nextModify

$_nextModify : array

next() modifiers.

Type

array

$_stream

$_stream : \Horde_Stream

Data stream.

Type

\Horde_Stream

Methods

__construct()

__construct(mixed  $data = null)

Constructor.

Parameters

mixed $data

Data to add (string, resource, or Horde_Stream object).

__clone()

__clone()

__get()

__get(  $name)

Parameters

$name

__sleep()

__sleep()

__toString()

__toString()

add()

add(mixed  $data)

Add data to buffer.

Parameters

mixed $data

Data to add (string, resource, or Horde_Stream object).

addLiteralStream()

addLiteralStream(mixed  $data)

Add data to literal stream at the current position.

Parameters

mixed $data

Data to add (string, resource, or Horde_Stream object).

flushIterator()

flushIterator(boolean  $return = true, boolean  $sublevel = true) : array

Flush the remaining entries left in the iterator.

Parameters

boolean $return

If true, return entries. Only returns entries on the current level.
boolean $sublevel

Only flush items in current sublevel?

Returns

array —

The entries if $return is true.

getLiteralLength()

getLiteralLength() : mixed

Return literal length data located at the end of the stream.

Returns

mixed —

Null if no literal data found, or an array with these keys:

  • binary: (boolean) True if this is a literal8.
  • length: (integer) Length of the literal.

current()

current()

key()

key()

next()

next() : mixed

Returns

mixed —

Either a string, boolean (true for open paren, false for close paren/EOS), Horde_Stream object, or null.

nextStream()

nextStream()

Force return of literal data as stream, if next token.

rewind()

rewind()

valid()

valid()