final class referenceMapObj (View source)

Instances of referenceMapObj are always embedded inside the mapObj_.

Properties

ColorObj $color
int $height
rectObj $extent
string $image
int $marker
string $markername
int $markersize
int $maxboxsize
int $minboxsize
ColorObj $outlinecolor
int $status
int $width

Methods

string
convertToString()

Saves the object to a string. Provides the inverse option for updateFromString.

void
free()

Free the object properties and break the internal references.

int
set(string $property_name, $new_value)

Set object property to a new value.

int
updateFromString(string $snippet)

Update a referenceMap object from a string snippet.

Details

final string convertToString()

Saves the object to a string. Provides the inverse option for updateFromString.

Return Value

string

final void free()

Free the object properties and break the internal references.

Note that you have to unset the php variable to free totally the resources.

Return Value

void

final int set(string $property_name, $new_value)

Set object property to a new value.

Parameters

string $property_name
$new_value

Return Value

int

final int updateFromString(string $snippet)

Update a referenceMap object from a string snippet.

Returns MS_SUCCESS/MS_FAILURE.

Parameters

string $snippet

Return Value

int