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

Class: ServerOutline

Source Location: /plugins/outline/server/ServerOutline.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ClientResponderAdapter
         |
         --ServerOutline

Server Outline class


Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 28]
Server Outline class



[ Top ]


Class Variables

$defaultStyles =

[line 45]

Array of default style classes



Tags:

access:  protected

Type:   array


[ Top ]

$log =

[line 33]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$styles =

[line 39]

Array of current style classes



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 50]

ServerOutline __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method computeKey [line 193]

string computeKey( ShapeStyle $shapeStyle, LabelStyle $labelStyle)

Computes a string key to identify a specific class



Tags:

access:  protected


Parameters:

ShapeStyle   $shapeStyle  
LabelStyle   $labelStyle  

[ Top ]

method convertPolygon [line 387]

MsPolygonObj convertPolygon( Polygon $polygon)

Converts a Polygon to a Mapserver polygon object



Tags:

access:  protected


Parameters:

Polygon   $polygon  

[ Top ]

method draw [line 490]

double draw( array $shapes, [boolean $maskMode = false])

Handles shapes drawing and area computation



Tags:

return:  area
access:  public


Parameters:

array   $shapes   array of StyledShape
boolean   $maskMode   mask mode

[ Top ]

method drawLine [line 331]

void drawLine( MsMapObj $msMapObj, StyledShape $line)

Adds a line to Mapserver layer



Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj   Mapserver Map object
StyledShape   $line   line

[ Top ]

method drawMap [line 475]

void drawMap( MsMapObj $msMapObj)

Draws map using drawQuery() or draw()



Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj   Mapserver Map object

[ Top ]

method drawPoint [line 300]

void drawPoint( MsMapObj $msMapObj, StyledShape $point)

Adds a point to Mapserver layer

If point layer is not defined in configuration file, tries with polygon layer.




Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj   Mapserver Map object
StyledShape   $point   point

[ Top ]

method drawPolygon [line 415]

void drawPolygon( MsMapObj $msMapObj, StyledShape $polygon, boolean $maskMode)

Adds a polygon to Mapserver layer

If not in mask mode, simply draws Polygon.

If in mask mode, uses MapScript pasteImage function to simulate a mask. This function doesn't include transparency handling. Mask color is set in configuration file, key maskColor.




Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj   Mapserver Map object
StyledShape   $polygon   polygon
boolean   $maskMode   mask mode on/off

[ Top ]

method drawRectangle [line 364]

void drawRectangle( MsMapObj $msMapObj, StyledShape $rectangle, boolean $maskMode)

Adds a rectangle to Mapserver layer



Tags:

access:  protected
see:  ServerOutline::drawPolygon()


Parameters:

MsMapObj   $msMapObj   Mapserver Map object
StyledShape   $rectangle   rectangle
boolean   $maskMode   mask mode on/off

[ Top ]

method findClass [line 243]

void findClass( MsMapObj $msMapObj, string $layerName, StyledShape $styledShape, MsLayer &$layer, int &$classIndex)

Returns layer and class index for a shape



Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj  
string   $layerName  
StyledShape   $styledShape  
MsLayer   &$layer  
int   &$classIndex  

[ Top ]

method getLayer [line 63]

MsLayer getLayer( MsMapObj $msMapObj, string $layerName)

Returns outline layer if it was defined



Tags:

return:  Mapserver Layer object
access:  protected


Parameters:

MsMapObj   $msMapObj   Mapserver Map object
string   $layerName   layer name

[ Top ]

method handleDrawing [line 545]

OutlineResult handleDrawing( OutlineRequest $requ)

Handles shapes drawing and area computation



Tags:

access:  public


Overrides ClientResponderAdapter::handleDrawing() (parent method not documented)

Parameters:

OutlineRequest   $requ  

[ Top ]

method initializeStyles [line 214]

void initializeStyles( MsMapObj $msMapObj, string $layerName)

Initializes styles array with layer information



Tags:

access:  protected


Parameters:

MsMapObj   $msMapObj  
string   $layerName  

[ Top ]

method serializeColor [line 182]

string serializeColor( Color $color)

Computes a string from a Color object



Tags:

access:  protected


Parameters:

Color   $color  

[ Top ]

method setColor [line 83]

void setColor( MsColorObj $msColorObj, Color &$color)

Sets a color object from a Mapserver color



Tags:

access:  protected


Parameters:

MsColorObj   $msColorObj  
Color   &$color  

[ Top ]

method setStyles [line 98]

void setStyles( MsLayerObj $msLayerObj, ShapeStyle &$shapeStyle, LabelStyle &$labelStyle)

Sets styles (shape & label) from a Mapserver layer



Tags:

access:  protected


Parameters:

MsLayerObj   $msLayerObj  
ShapeStyle   &$shapeStyle  
LabelStyle   &$labelStyle  

[ Top ]

method updateClass [line 148]

void updateClass( MsClassObj &$msClassObj, ShapeStyle $shapeStyle, LabelStyle $labelStyle)

Updates a Mapserver class from styles (shape & label)



Tags:

access:  protected


Parameters:

MsClassObj   &$msClassObj  
ShapeStyle   $shapeStyle  
LabelStyle   $labelStyle  

[ Top ]

method updateColor [line 129]

void updateColor( MsColorObj &$msColorObj, Color $color)

Updates a Mapserver color from a Color object



Tags:

access:  protected


Parameters:

MsColorObj   &$msColorObj  
Color   $color  

[ Top ]


Documentation generated on Fri, 11 Nov 2005 11:00:16 +0000 by phpDocumentor 1.3.0RC3