Class IMP_Flag_Base

This class provides the data structure for a message flag.

IMP_Flag_Base implements Serializable

Direct known subclasses

IMP_Flag_Imap, IMP_Flag_System_Match_Address, IMP_Flag_System_Match_Flag, IMP_Flag_System_Match_Header

Indirect known subclasses

IMP_Flag_Imap_Answered, IMP_Flag_Imap_Deleted, IMP_Flag_System_HighPriority, IMP_Flag_System_List, IMP_Flag_System_LowPriority, IMP_Flag_System_Personal, IMP_Flag_System_Signed, IMP_Flag_System_Unseen, IMP_Flag_User, IMP_Flag_Imap_Draft, IMP_Flag_Imap_Flagged, IMP_Flag_Imap_Forwarded, IMP_Flag_Imap_Junk, IMP_Flag_Imap_NotJunk, IMP_Flag_Imap_Seen, IMP_Flag_System_Attachment, IMP_Flag_System_Encrypted

Abstract
Package: IMP
Category: Horde
Copyright: 2010-2014 Horde LLC
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Flag/Base.php

Methods summary
`public`	# `__get( mixed $name )`
`public`	# `__set( string $name, string $value )` Set properties. Set properties. Parameters `$name` <p>Available properties: - bgcolor: (string) The background color.</p> `$value` Property value.
`public mixed`	# `changed( array $obs, boolean $add )` Given a list of flag objects, determines if this flag's status has changed. Given a list of flag objects, determines if this flag's status has changed. Parameters `$obs` A list of IMP_Flag_Base objects. `$add` <p>True if these flags were added, false if they were removed.</p> Returns `mixed` Null if no change, true if flag is added, false if flag is removed.
`public string`	# `getLabel( boolean $set = true )` Return the flag label. Return the flag label. Parameters `$set` Return label for setting the flag? Returns `string` The label.
`public boolean`	# `match( mixed $data )` Determines if the flag exists given some input data. Determines if the flag exists given some input data. Parameters `$data` The input data to check. Returns `boolean` True if flag exists.
`public string`	# `__toString( )` String representation of the object. String representation of the object. Returns `string` String representation (Flag ID).
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Implementation of `Serializable::unserialize()`

Constants summary
`string`	`DEFAULT_BG`	# `'#fff'`

Magic properties summary
`public string`	`$bgcolor` The background color.
`public string`	`$abbreviation` The abbreviation to use in the minimal view.
`public boolean`	`$bgdefault` Is the background color the default?
`public boolean`	`$canset` Can this flag be set by the user?
`public string`	`$css` The CSS class for the icon when the flag is set.
`public string`	`$cssicon` The CSS class for the icon.
`public string`	`$fgcolor` The foreground (text) color.
`public string`	`$form_set` Form value to use when setting flag.
`public string`	`$form_unset` Form value to use when unsetting flag.
`public string`	`$hash` Unique hash of this flag.
`public string`	`$id` Unique ID.
`public string`	`$label` The query label.
`public string`	`$span` Return SPAN HTML to output the icon for use in a mailbox row.

Packages

Classes

Interfaces

Class IMP_Flag_Base

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Implementation of

Implementation of