Plugins

# Class: ServerOutline Source Location: /plugins/outline/server/ServerOutline.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
          |
          --ClientResponderAdapter
             |
             --ServerOutline
Server Outline class | ### Variables $log $pathToSymbols $symbolType | ### Methods __construct draw drawFeature drawLine drawMap drawPoint drawPolygon generateSymbolIcon getInit getMsClass handleDrawing toShapeObj
### Inherited Variables #### Class: ServerPlugin ServerPlugin::$config ServerPlugin::$serverContext #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### Class: ClientResponderAdapter ClientResponderAdapter::handleDrawing() ClientResponderAdapter::handlePostDrawing() ClientResponderAdapter::handlePreDrawing() ClientResponderAdapter::initializeRequest() #### 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 Outline class [ Top ] ### Class Variables #### $log = [line 34] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $pathToSymbols = [line 39] #### Tags:
access: | protected
Type: | string
[ Top ] #### $symbolType = [line 44] #### Tags:
access: | protected
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 50]
`ServerOutline __construct( )`
Constructor #### Tags:
access: | public
Overrides ServerPlugin::__construct() (Constructor) [ Top ] ### method draw [line 257]
`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 drawFeature [line 93]
`void drawFeature( StyledShape $shape, string $layerName)`
#### Tags:
access: | protected
#### Parameters:
StyledShape | $shape |
string | $layerName |
[ Top ] ### method drawLine [line 179]
`void drawLine( StyledShape $line)`
Adds a line to Mapserver layer #### Tags:
access: | protected
#### Parameters:
StyledShape | $line | line
[ Top ] ### method drawMap [line 242]
`void drawMap( MsMapObj $msMapObj)`
Draws map using drawQuery() or draw() #### Tags:
access: | protected
#### Parameters:
MsMapObj | $msMapObj | Mapserver Map object
[ Top ] ### method drawPoint [line 167]
`void drawPoint( 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:
StyledShape | $point | point
[ Top ] ### method drawPolygon [line 197]
`void drawPolygon( MsMapObj $polygon, StyledShape $maskMode, boolean 2)`
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:
boolean | 2 | mask mode on/off
MsMapObj | $polygon | Mapserver Map object
StyledShape | $maskMode | polygon
[ Top ] ### method generateSymbolIcon [line 414]
`void generateSymbolIcon( )`
Generate symbol icons to be used with symbol picker #### Tags:
access: | protected
[ Top ] ### method getInit [line 321]
`void getInit( )`
#### Tags:
access: | public
see: | InitProvider::getInit
[ Top ] ### method getMsClass [line 149]
`ClassOverlay getMsClass( StyleOverlay $shapeStyle, LabelOverlay $labelStyle)`
#### Tags:
access: | protected
#### Parameters:
StyleOverlay | $shapeStyle |
LabelOverlay | $labelStyle |
[ Top ] ### method handleDrawing [line 309]
`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 toShapeObj [line 59]
`ms_styleObj toShapeObj( Shape $shape)`
#### Tags:
access: | protected
#### Parameters:
Shape | $shape |
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:04 +0200 by phpDocumentor 1.3.0RC3