Class IMP_Flag_Base
This class provides the data structure for a message flag.
Copyright 2010-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
-
IMP_Flag_Base
implements
Serializable
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
Methods summary
public
mixed
|
#
__get( string $name )
Get object properties.
Parameters
- $name
- Available properties:
<pre><span class="php-quote">'abbreviation'</span> - (string) The abbreviation to <span class="php-keyword1">use</span> in the mimp view.
<span class="php-quote">'bgcolor'</span> - (string) The background color.
<span class="php-quote">'bgdefault'</span> - (boolean) Is the backgroud color the <span class="php-keyword1">default</span>?
<span class="php-quote">'canset'</span> - (boolean) Can this flag be set by the user?
<span class="php-quote">'css'</span> - (string) The CSS <span class="php-keyword1">class</span> <span class="php-keyword1">for</span> the icon when the flag is set.
<span class="php-quote">'cssicon'</span> - (string) The CSS <span class="php-keyword1">class</span> <span class="php-keyword1">for</span> the icon.
<span class="php-quote">'span'</span> - (string) <span class="php-keyword1">Return</span> SPAN HTML to output the icon <span class="php-keyword1">for</span> <span class="php-keyword1">use</span> in a
mailbox row.
<span class="php-quote">'fgcolor'</span> - (string) The foreground (text) color.
<span class="php-quote">'form_set'</span> - (string) Form value to <span class="php-keyword1">use</span> when setting flag.
<span class="php-quote">'form_unset'</span> - (string) Form value to <span class="php-keyword1">use</span> when unsetting flag.
<span class="php-quote">'id'</span> - (string) Unique ID.
<span class="php-quote">'label'</span> - (string) The query label.</pre>
Returns
mixed
Property value.
|
public
|
#
__set( string $name, string $value )
Set properties.
Parameters
- $name
- Available properties:
<span class="php-quote">'bgcolor'</span> - (string) The background color.
- $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
mixedNull if no change, true if flag is added, false if flag
is removed.
|
public
string
|
#
getLabel( boolean $set = true )
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()
|