PHP 클래스 Horde_Imap_Client_Ids, horde

저자: Michael Slusarz ([email protected])

상속: implements Countable, implements Iterator, implements Serializable

공개 프로퍼티들

프로퍼티	타입	설명
$duplicates	boolean	Allow duplicate IDs?

보호된 프로퍼티들

프로퍼티	타입	설명
$_ids	mixed	List of IDs.
$_sequence	boolean	Are IDs message sequence numbers?
$_sorted	boolean	Are IDs sorted?

공개 메소드들

메소드	설명
__construct ( mixed $ids = null, boolean $sequence = false )	Constructor.
__get ( $name )
__toString ( )
add ( mixed $ids )	Add IDs to the current object.
count ( )
current ( )
isEmpty ( ) : boolean	Is this object empty (i.e. does not contain IDs)?
key ( )
next ( )
remove ( mixed $ids )	Removed IDs from the current object.
reverse ( )	Reverses the order of the IDs.
rewind ( )
serialize ( )
sort ( )	Sorts the IDs.
split ( integer $length ) : array	Split the sequence string at an approximate length.
unserialize ( $data )
valid ( )

보호된 메소드들

메소드	설명
_fromSequenceString ( string $str ) : array	Parse an IMAP message sequence string into a list of indices.
_resolveIds ( mixed $ids ) : array	Resolve the $ids input to add() and remove().
_sort ( array &$ids )	Sorts the IDs numerically.
_toSequenceString ( boolean $sort = true ) : string	Create an IMAP message sequence string from a list of indices.

메소드 상세

__construct() 공개 메소드

Constructor.

public __construct ( mixed $ids = null, boolean $sequence = false )
$ids	mixed	See self::add().
$sequence	boolean	Are $ids message sequence numbers?

__get() 공개 메소드

public __get ( $name )

__toString() 공개 메소드

public __toString ( )

_fromSequenceString() 보호된 메소드

Parse an IMAP message sequence string into a list of indices.

또한 보기: _toSequenceString()

protected _fromSequenceString ( string $str ) : array
$str	string	The IMAP message sequence string.
리턴	array	An array of indices.

_resolveIds() 보호된 메소드

Resolve the $ids input to add() and remove().

protected _resolveIds ( mixed $ids ) : array
$ids	mixed	Either Horde_Imap_Client_Ids object, array, or sequence string.
리턴	array	An array of IDs.

_sort() 보호된 메소드

Sorts the IDs numerically.

protected _sort ( array &$ids )
$ids	array	The array list.

_toSequenceString() 보호된 메소드

Index Format: range_start:range_end,uid,uid2,...

protected _toSequenceString ( boolean $sort = true ) : string
$sort	boolean	Numerically sort the IDs before creating the range?
리턴	string	The IMAP message sequence string.

add() 공개 메소드

Add IDs to the current object.

public add ( mixed $ids )
$ids	mixed	Either self::ALL, self::SEARCH_RES, self::LARGEST, Horde_Imap_Client_Ids object, array, or sequence string.

count() 공개 메소드

public count ( )

current() 공개 메소드

public current ( )

isEmpty() 공개 메소드

Is this object empty (i.e. does not contain IDs)?

public isEmpty ( ) : boolean
리턴	boolean	True if object is empty.

key() 공개 메소드

public key ( )

next() 공개 메소드

public next ( )

remove() 공개 메소드

Removed IDs from the current object.

부터: 2.17.0

public remove ( mixed $ids )
$ids	mixed	Either Horde_Imap_Client_Ids object, array, or sequence string.

reverse() 공개 메소드

Reverses the order of the IDs.

public reverse ( )

rewind() 공개 메소드

public rewind ( )

serialize() 공개 메소드

public serialize ( )

sort() 공개 메소드

Sorts the IDs.

public sort ( )

split() 공개 메소드

Split the sequence string at an approximate length.

부터: 2.7.0

public split ( integer $length ) : array
$length	integer	Length to split.
리턴	array	A list containing individual sequence strings.

unserialize() 공개 메소드

public unserialize ( $data )

valid() 공개 메소드

public valid ( )

프로퍼티 상세

$_ids 보호되어 있는 프로퍼티

List of IDs.

protected mixed $_ids
리턴	mixed

$_sequence 보호되어 있는 프로퍼티

Are IDs message sequence numbers?

protected bool $_sequence
리턴	boolean

$_sorted 보호되어 있는 프로퍼티

Are IDs sorted?

protected bool $_sorted
리턴	boolean

$duplicates 공개적으로 프로퍼티

Allow duplicate IDs?

public bool $duplicates
리턴	boolean