Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: ServerMapOverlay

Source Location: /plugins/mapOverlay/server/ServerMapOverlay.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ServerMapOverlay

Server MapOverlay class


Variables

Methods


Inherited Variables

Inherited Methods

Class: ServerPlugin

ServerPlugin::__construct()
Constructor
ServerPlugin::getConfig()
ServerPlugin::getServerContext()
ServerPlugin::initializeConfig()
Initializes plugin configuration
ServerPlugin::useExtendedInit()
ServerPlugin::useExtendedRequest()
ServerPlugin::useExtendedResult()

Class: PluginBase

PluginBase::__construct()
Constructor
PluginBase::account()
Records an accounting message for plugins
PluginBase::getBasePath()
PluginBase::getExtendedName()
PluginBase::getName()
PluginBase::getRequest()
Get plugin's request or result out of MapRequest or MapResult
PluginBase::initialize()
Plugin initialization (can be extended in custom plugins)
PluginBase::initializeConfig()
Initializes plugin
PluginBase::preInitialize()
Plugin pre initialization. In most cases, plugins should use
PluginBase::replacePlugin()
Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 28]
Server MapOverlay class



[ Top ]


Class Variables

$log =

[line 33]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$mapObj =

[line 38]



Tags:

access:  protected

Type:   MapObj


[ Top ]



Class Methods


constructor __construct [line 44]

ServerMapOverlay __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method checkClassLabel [line 429]

void checkClassLabel( ms_class_obj $msClass, ClassOverlay $overlay)

Finds out if class label matches overlay label



Tags:

access:  public


Parameters:

ms_class_obj   $msClass  
ClassOverlay   $overlay  

[ Top ]

method checkClassStyles [line 397]

boolean checkClassStyles( mixed $msClass, ClassOverlay $overlay)

Finds out if class styles match overlay styles



Tags:

access:  public


[ Top ]

method checkColor [line 337]

boolean checkColor( ms_color_obj $msObject, string $property, ColorOverlay $overlay)



Tags:

access:  public


Parameters:

ms_color_obj   $msObject  
string   $property  
ColorOverlay   $overlay  

[ Top ]

method checkStyle [line 358]

boolean checkStyle( ms_style_obj $msStyle, StyleOverlay $overlay)



Tags:

access:  public


Parameters:

ms_style_obj   $msStyle  
StyleOverlay   $overlay  

[ Top ]

method getClass [line 293]

ms_class_obj getClass( ms_layer_obj $msLayer, ClassOverlay $overlay, [boolean $copy = false])

Return



Tags:

access:  private


Parameters:

ms_layer_obj   $msLayer  
ClassOverlay   $overlay  
boolean   $copy  

[ Top ]

method getClassIndex [line 321]

void getClassIndex( ms_layer_obj $msLayer, integer $name)



Tags:

access:  private


Parameters:

ms_layer_obj   $msLayer  
integer   $name  

[ Top ]

method getLayer [line 685]

void getLayer( mixed $overlay, [mixed $copy = false])



Tags:

access:  public


[ Top ]

method updateClass [line 462]

ClassOverlay updateClass( ms_layer_obj $msLayer, ClassOverlay $overlay)



Tags:

access:  protected


Parameters:

ms_layer_obj   $msLayer  
ClassOverlay   $overlay  

[ Top ]

method updateColor [line 57]

ColorOverlay updateColor( ms_style_obj $msObject, ColorOverlay $property, ColorOverlay $overlay)

Update the color.

'property' is one of 'color', 'outlinecolor' or 'backroundcolor'




Tags:

access:  protected


Parameters:

ms_style_obj   $msObject  
ColorOverlay   $property  

[ Top ]

method updateLabel [line 229]

LabelOverlay updateLabel( ms_class_obj $msClass, LabelOverlay $overlay)



Tags:

access:  private


Parameters:

ms_class_obj   $msClass  
LabelOverlay   $overlay  

[ Top ]

method updateLayer [line 707]

LayerOverlay updateLayer( LayerOverlay $overlay)



Tags:

access:  protected


Parameters:

LayerOverlay   $overlay  

[ Top ]

method updateMap [line 1008]

BasicOverlay updateMap( BasicOverlay $overlay)

Updates mapfile using a MapOverlay or a LayerOverlay, returns the same

object with useful info




Tags:

access:  public


Parameters:

BasicOverlay   $overlay  

[ Top ]

method updateMetadata [line 638]

MetadataOverlay updateMetadata( MetadataOverlay $msLayer, MetadataOverlay $overlay)



Tags:

access:  public


Parameters:

MetadataOverlay   $msLayer  

[ Top ]

method updateStyle [line 110]

void updateStyle( ms_class_obj $msClass, StyleOverlay $overlay)

Update style



Tags:

access:  protected


Parameters:

ms_class_obj   $msClass  
StyleOverlay   $overlay  

[ Top ]


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