Class: ColorOverlay

Source Location: /plugins/mapOverlay/common/MapOverlay.php

Class Overview

CwSerializable
   |
   --BasicOverlay
      |
      --ColorOverlay

ColorOverlay

Variables

Methods

Inherited Constants

Class: BasicOverlay

BasicOverlay::ACTION_INSERT
BasicOverlay::ACTION_REMOVE
BasicOverlay::ACTION_SEARCH
BasicOverlay::ACTION_UPDATE

Inherited Variables

Class: BasicOverlay

BasicOverlay::$action
BasicOverlay::$copyIndex
BasicOverlay::$id
BasicOverlay::$index
BasicOverlay::$position

Class: CwSerializable

CwSerializable::$className

Inherited Methods

Class: BasicOverlay

BasicOverlay::__construct(): Constructor
BasicOverlay::unserialize()

Class: CwSerializable

CwSerializable::__construct(): Constructor
CwSerializable::copyAllVars(): Copy all properties from one object to another (overwriting previous ones)
CwSerializable::getValue(): Returns structure's property value if property exists
CwSerializable::guessClassName(): Tries to guess the class to use from the property being unserialised.
CwSerializable::unserialize(): Unserializes from a stdClass structure
CwSerializable::unserializeArray(): Returns an array of typed values
CwSerializable::unserializeObject(): Returns an unserialized object from a stdClass structure
CwSerializable::unserializeObjectMap(): Returns an array of unserialized objects from a stdClass structure
CwSerializable::unserializeStringArray(): Returns an array of typed values from a string
CwSerializable::unserializeValue(): Returns a typed value from a structure property

Class Details

[line 124]
ColorOverlay

[ Top ]

Class Variables

$blue =

[line 139]

Tags:

access:

public

Type:

int

[ Top ]

$green =

[line 134]

Tags:

access:

public

Type:

int

[ Top ]

$red =

[line 129]

Tags:

access:

public

Type:

int

[ Top ]

Class Methods

method getHex [line 176]

string getHex(
)

Returns the hexadecimal representation of the color or an empty string if not applicable. For example, returns '#ff0000' if red=255, green=0, blue=0.

Tags:

access:

public

[ Top ]

method isValid [line 188]

boolean isValid(
)

Returns check if the color is a valid color

Tags:

access:

public

[ Top ]

method setFromHex [line 159]

void setFromHex(
string
$hex)

Initializes color from an hexadecimal color, this string must

look like '#rrggbb'. Passing an empty string unset the color

Tags:

access:

public

Parameters:

string

$hex

hexadecimal color

[ Top ]

method setFromRGB [line 148]

void setFromRGB(
integer
$red, integer
$green, integer
$blue)

Initializes color from red, green, blue values

Tags:

access:

public

Parameters:

integer	$red	red value
integer	$green	green value
integer	$blue	blue value

[ Top ]

method unserialize [line 197]

void unserialize(
mixed
$struct)

Tags:

access:	public
see:	CwSerializable::unserialize()

Overrides BasicOverlay::unserialize() (parent method not documented)

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:30:54 +0200 by phpDocumentor 1.3.0RC3