PHP 클래스 IMP_Flags, horde

저자: Michael Slusarz ([email protected])
상속: implements ArrayAccess, implements Serializable
파일 보기 프로젝트 열기: horde/horde

공개 프로퍼티들

프로퍼티 타입 설명
$changed boolean Has the object data changed?

보호된 프로퍼티들

프로퍼티 타입 설명
$_flaghook boolean Does the msglist_flags hook exist?
$_flags array The list of internal flags.
$_userflags array The list of user flags.

공개 메소드들

메소드 설명
__construct ( ) Constructor.
addFlag ( string $label ) : string Add a user-defined IMAP flag.
changed ( array $flags, boolean $add ) : array Returns a list of flags that have changed due to IMAP flag changes.
getList ( array $opts = [] ) : array Return the raw list of flags.
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
parse ( array $opts = [] ) : array Parse a list of flag information.
serialize ( )
unserialize ( $data )
updateFlag ( string $key, string $type, string $data ) Updates flag properties.

보호된 메소드들

메소드 설명
_save ( ) Save the flag list to the prefs backend.

메소드 상세

__construct() 공개 메소드

Constructor.
public __construct ( )

_save() 보호된 메소드

Save the flag list to the prefs backend.
protected _save ( )

addFlag() 공개 메소드

Add a user-defined IMAP flag.
public addFlag ( string $label ) : string
$label string The label to use for the new flag.
리턴 string The IMAP flag name.

changed() 공개 메소드

Returns a list of flags that have changed due to IMAP flag changes.
public changed ( array $flags, boolean $add ) : array
$flags array The list of IMAP flags added/removed.
$add boolean True if these flags were added, false if they were removed.
리턴 array Array with two keys: 'add' and 'remove'. Each key contains a list of IMP_Flag_Base objects.

getList() 공개 메소드

Return the raw list of flags.
public getList ( array $opts = [] ) : array
$opts array Additional options: - imap: (boolean) If true, only return IMAP flags that can be set by the user. DEFAULT: false - mailbox: (string) A real (not virtual) IMAP mailbox. If set, will determine what flags are available in the mailbox. DEFAULT: '' (no mailbox check)
리턴 array An array of IMP_Flag_Base elements.

offsetExists() 공개 메소드

public offsetExists ( $offset )

offsetGet() 공개 메소드

public offsetGet ( $offset )

offsetSet() 공개 메소드

public offsetSet ( $offset, $value )

offsetUnset() 공개 메소드

public offsetUnset ( $offset )

parse() 공개 메소드

Parse a list of flag information.
public parse ( array $opts = [] ) : array
$opts array Options: - flags: (array) IMAP flag info. A lowercase list of flags returned by the IMAP server. - headers: (Horde_Mime_Headers) Determines message information from a headers object. - runhook: (array) Run the msglist_flags hook? If yes, input is return from IMP_Mailbox_List#getMailboxArray(). - personal: (mixed) Personal message info. Either a list of To addresses (Horde_Mail_Rfc822_List object) or the identity that matched the address list. - structure: TODO
리턴 array A list of IMP_Flag_Base objects.

serialize() 공개 메소드

public serialize ( )

unserialize() 공개 메소드

public unserialize ( $data )

updateFlag() 공개 메소드

Updates flag properties.
public updateFlag ( string $key, string $type, string $data )
$key string The flag key.
$type string The property to update. Either 'bgcolor' or 'label'.
$data string The updated data.

프로퍼티 상세

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

Does the msglist_flags hook exist?
protected bool $_flaghook
리턴 boolean

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

The list of internal flags.
protected array $_flags
리턴 array

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

The list of user flags.
protected array $_userflags
리턴 array

$changed 공개적으로 프로퍼티

Has the object data changed?
public bool $changed
리턴 boolean