CorePlugins

# Class: ServerLocation Source Location: /coreplugins/location/server/ServerLocation.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
          |
          --ClientResponderAdapter
             |
             --ServerLocation
Server part of Location plugin | ### Variables $crosshair $initialExtent $log $scales $showRefLines $showRefMarks $visibleScales | ### Methods __construct addRefMarksShape adjustBbox adjustScale doBboxAdjusting doLocation getInit getLocationResult getRefMarksShapes getScaleFromBbox getScales handleCorePlugin handleDrawing initScales
### Child classes: | ### 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 579] Server part of Location plugin [ Top ] ### Class Variables #### $crosshair = [line 590] #### Tags:
access: | protected
Type: | StyledShape
[ Top ] #### $initialExtent = [line 618] Initial Extent of the map (the mapfile one) #### Tags:
access: | protected
Type: | Bbox
[ Top ] #### $log = [line 585] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $scales = [line 606] Possible scales in discrete mode (some may be hidden) #### Tags:
access: | protected
Type: | array
[ Top ] #### $showRefLines = false [line 600] #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $showRefMarks = false [line 595] #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $visibleScales = [line 612] Scales to be displayed in dropdown box #### Tags:
access: | protected
Type: | array
[ Top ] ### Class Methods ### constructor __construct [line 623]
`ServerLocation __construct( )`
Constructor #### Tags:
access: | public
Overrides ServerPlugin::__construct() (Constructor) [ Top ] ### method addRefMarksShape [line 856]
`void addRefMarksShape( array &$shapes, array $points, double $cx, double $cy, double $r, StyleOverlay $style, [LabelOverlay $labelStyle = NULL], [string $label = ''])`
Adds RefMark shapes. #### Tags:
access: | protected
#### Parameters:
array | &$shapes | array of StyledShape
array | $points | array of Point
double | $cx |
double | $cy |
double | $r |
StyleOverlay | $style |
LabelOverlay | $labelStyle |
string | $label |
[ Top ] ### method adjustBbox [line 699]
`Bbox adjustBbox( Bbox $oldBbox, [msExtent $maxExtent = NULL])`
Adjusts Bbox using a maximum extent #### Tags:
access: | protected
#### Parameters:
Bbox | $oldBbox |
msExtent | $maxExtent |
[ Top ] ### method adjustScale [line 677]
`double adjustScale( double $scale)`
Adjusts scale using min/max set in configuration #### Tags:
access: | protected
#### Parameters:
double | $scale |
[ Top ] ### method doBboxAdjusting [line 805]
`void doBboxAdjusting( [msExtent $maxExtent = NULL])`
Adjusts Bbox #### Tags:
access: | protected
#### Parameters:
msExtent | $maxExtent |
[ Top ] ### method doLocation [line 779]
`void doLocation( Bbox $bbox, double $scale)`
Applies location changes to MapServer #### Tags:
access: | protected
#### Parameters:
Bbox | $bbox |
double | $scale |
[ Top ] ### method getInit [line 1194]
`void getInit( )`
#### Tags:
access: | public
see: | InitProvider::getInit()
[ Top ] ### method getLocationResult [line 828]
`LocationResult getLocationResult( )`
Prepares result that will be sent to client #### Tags:
access: | protected
[ Top ] ### method getRefMarksShapes [line 885]
`array getRefMarksShapes( )`
Returns shapes for reference marks #### Tags:
return: | array of shapes
access: | protected
[ Top ] ### method getScaleFromBbox [line 663]
`double getScaleFromBbox( Bbox $bbox)`
Computes scale from a Bbox using MapServer #### Tags:
access: | protected
#### Parameters:
Bbox | $bbox |
[ Top ] ### method getScales [line 651]
`array getScales( )`
#### Tags:
access: | public
[ Top ] ### method handleCorePlugin [line 1128]
`void handleCorePlugin( mixed $requ)`
#### Tags:
access: | public
see: | CoreProvider::handleCorePlugin()
Overridden in child classes as: ServerProjectLocation::handleCorePlugin() [ Top ] ### method handleDrawing [line 1099]
`void handleDrawing( mixed $requ)`
Draw the crosshair and reference marks. #### Tags:
access: | public
see: | ClientResponderAdapter::handleDrawing()
Overrides ClientResponderAdapter::handleDrawing() (parent method not documented) [ Top ] ### method initScales [line 631]
`void initScales( )`
Initializes scales from location.ini #### Tags:
access: | protected
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:04 +0200 by phpDocumentor 1.3.0RC3