PHP Class Horde_Imap_Client_Tokenize, horde

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.

Author: Michael Slusarz ([email protected])

Inheritance: implements Iterator

Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_current	mixed	Current data.
$_key	integer	Current key.
$_level	integer	Sublevel.
$_literalStream	boolean	Return Horde_Stream object for literal tokens?
$_literals	array	Array of literal stream objects.
$_nextModify	array	next() modifiers.
$_stream	Horde_Stream	Data stream.

Public Methods

Method	Description
__clone ( )
__construct ( mixed $data = null )	Constructor.
__get ( $name )
__sleep ( )
__toString ( )
add ( mixed $data )	Add data to buffer.
addLiteralStream ( mixed $data )	Add data to literal stream at the current position.
current ( )
flushIterator ( boolean $return = true, boolean $sublevel = true ) : array	Flush the remaining entries left in the iterator.
getLiteralLength ( ) : mixed	Return literal length data located at the end of the stream.
key ( )
next ( ) : mixed
nextStream ( )	Force return of literal data as stream, if next token.
rewind ( )
valid ( )

Method Details

__clone() public method

public __clone ( )

__construct() public method

Constructor.

public __construct ( mixed $data = null )
$data	mixed	Data to add (string, resource, or Horde_Stream object).

__get() public method

public __get ( $name )

__sleep() public method

public __sleep ( )

__toString() public method

public __toString ( )

add() public method

Add data to buffer.

public add ( mixed $data )
$data	mixed	Data to add (string, resource, or Horde_Stream object).

addLiteralStream() public method

Add data to literal stream at the current position.

public addLiteralStream ( mixed $data )
$data	mixed	Data to add (string, resource, or Horde_Stream object).

current() public method

public current ( )

flushIterator() public method

Flush the remaining entries left in the iterator.

public flushIterator ( boolean $return = true, boolean $sublevel = true ) : array
$return	boolean	If true, return entries. Only returns entries on the current level.
$sublevel	boolean	Only flush items in current sublevel?
return	array	The entries if $return is true.

getLiteralLength() public method

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

public getLiteralLength ( ) : mixed
return	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.

key() public method

public key ( )

next() public method

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

nextStream() public method

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

rewind() public method

public rewind ( )

valid() public method

public valid ( )

Property Details

$_current protected property

Current data.

protected mixed $_current
return	mixed

$_key protected property

Current key.

protected int $_key
return	integer

$_level protected property

Sublevel.

protected int $_level
return	integer

$_literalStream protected property

Return Horde_Stream object for literal tokens?

protected bool $_literalStream
return	boolean

$_literals protected property

Array of literal stream objects.

protected array $_literals
return	array

$_nextModify protected property

next() modifiers.

protected array $_nextModify
return	array

$_stream protected property

Data stream.

protected Horde_Stream $_stream
return	Horde_Stream