PHP Class IMP_Flag_Base, horde

Author: Michael Slusarz ([email protected])
Inheritance: implements Serializable
Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство Type Description
$_bgcolor string The background color.
$_canset boolean Is this flag settable by the user?
$_css string The CSS class.
$_cssIcon string The CSS class for the icon.
$_id string Unique ID.

Méthodes publiques

Méthode Description
__get ( $name )
__set ( string $name, string $value ) Set properties.
__toString ( ) : string String representation of the object.
changed ( array $obs, boolean $add ) : mixed Given a list of flag objects, determines if this flag's status has changed.
getLabel ( boolean $set = true ) : string Return the flag label.
serialize ( )
unserialize ( $data )

Méthodes protégées

Méthode Description
_getLabel ( ) : string Return the flag label.

Method Details

__get() public méthode

public __get ( $name )

__set() public méthode

Set properties.
public __set ( string $name, string $value )
$name string Available properties: - bgcolor: (string) The background color.
$value string Property value.

__toString() public méthode

String representation of the object.
public __toString ( ) : string
Résultat string String representation (Flag ID).

_getLabel() abstract protected méthode

Necessary evil as gettext strings can not be set directly to object properties.
abstract protected _getLabel ( ) : string
Résultat string The label.

changed() public méthode

Given a list of flag objects, determines if this flag's status has changed.
public changed ( array $obs, boolean $add ) : mixed
$obs array A list of IMP_Flag_Base objects.
$add boolean True if these flags were added, false if they were removed.
Résultat mixed Null if no change, true if flag is added, false if flag is removed.

getLabel() public méthode

Return the flag label.
public getLabel ( boolean $set = true ) : string
$set boolean Return label for setting the flag?
Résultat string The label.

serialize() public méthode

public serialize ( )

unserialize() public méthode

public unserialize ( $data )

Property Details

$_bgcolor protected_oe property

The background color.
protected string $_bgcolor
Résultat string

$_canset protected_oe property

Is this flag settable by the user?
protected bool $_canset
Résultat boolean

$_css protected_oe property

The CSS class.
protected string $_css
Résultat string

$_cssIcon protected_oe property

The CSS class for the icon.
protected string $_cssIcon
Résultat string

$_id protected_oe property

Unique ID.
protected string $_id
Résultat string