Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]
Packages:
CartoWeb3
Client
Common
CorePlugins
Htdocs
Plugins
Scripts
Server
Tests


Files:
ClientAuth.php
ClientBboxHistory.php
ClientCheckInstall.php
ClientCheckInstall.php
ClientCheckInstall.php
ClientDemoRouting.php
ClientEdit.php
ClientExportCsv.php
ClientExportDxf.php
ClientExportHtml.php
ClientExportPdf.php
ClientFilterIdrecenter.php
ClientGeostat.php
ClientHello.php
ClientLayerReorder.php
ClientLocate.php
ClientMapOverlay.php
ClientOgcLayerLoader.php
ClientOutline.php
ClientRouting.php
ClientSearch.php
ClientTestMainTableRules.php
ClientViews.php
ClientWmsBrowserLight.php
CwFpdf.php
Edit.php
ExportPdf.php
ExportPdfObjects.php
Geostat.php
LayerReorder.php
LayerResult.php
MapOverlay.php
OgcLayerLoader.php
Outline.php
OwsInfoHarwester.php
OwsInfoHarwesterOLL.php
PdfLibLite.php
QueryableLayer.php
Routing.php
Search.php
ServerDemoRouting.php
ServerEdit.php
ServerExportPdf.php
ServerGeostat.php
ServerHilight.php
ServerLayerReorder.php
ServerMapOverlay.php
ServerOgcLayerLoader.php
ServerOutline.php
ServerProjectGeotoolsRouting.php
ServerProjectPostgresRouting.php
ServerProjectRouting.php
ServerRouting.php
ServerSearch.php
ServerTestMainGeotoolsRouting.php
ServerTestMainPostgresRouting.php
ServerTestMainRouting.php
ToolTipsLayerBase.php
ToolTipsService.php

Classes:
Attribute
BasicOverlay
ByXyQueryableLayer
cFPDF
ClassOverlay
ClientAuth
ClientBboxHistory
ClientBboxHistoryState
ClientCheckInstall
ClientDemoRouting
ClientEdit
ClientExportCsv
ClientExportDxf
ClientExportHtml
ClientExportPdf
ClientFilterIdrecenter
ClientGeostat
ClientHello
ClientLayerReorder
ClientLocate
ClientMapOverlay
ClientOgcLayerLoader
ClientOutline
ClientProjectToolTips
ClientRouting
ClientSearch
ClientToolTips
ClientViews
ClientWmsBrowserLight
ColorOverlay
CwFpdf
DbResultProvider
DbSecurityContainer
DxfShape
Edge
EditRequest
EditResult
EditState
ExportPdfInit
ExportPdfState
FulltextTableResultProvider
GeostatChoropleth
GeostatClientState
GeostatInit
GeostatLayerParams
GeostatRequest
GeostatResult
IniSecurityContainer
JsonResponseFormatter
LabelOverlay
LayerOverlay
LayerReorderInit
LayerReorderRequest
LayerReorderResult
LayerReorderState
LayerResult
LayerTransparency
LdapSecurityContainer
MapOverlay
MetadataOverlay
Node
OgcLayerLoaderRequest
OgcLayerLoaderState
OutlineDefaultValue
OutlineInit
OutlineRequest
OutlineResult
OutlineState
OutlineV1ToV2
OutlineV2ToV3
OwsInfoHarwester
OwsInfoHarwesterOLL
Parameter
PdfBlock
PdfFormat
PdfGeneral
PdfLibLite
PdfWriter
PositionOverlay
PostgresGraph
PrintTools
ProxyAuthContainer
QueryableLayer
Radio_ptLayerResult
ResponseFormatter
ResultProvider
RoutingRequest
RoutingResult
RoutingState
SearchConfig
SearchParameter
SearchRequest
SearchResult
SearchUtils
ServerDemoRouting
ServerEdit
ServerExportPdf
ServerGeostat
ServerGeotoolsRouting
ServerHilight
ServerLayerReorder
ServerMapOverlay
ServerOgcLayerLoader
ServerOutline
ServerPostgresRouting
ServerProjectGeotoolsRouting
ServerProjectPostgresRouting
ServerProjectRouting
ServerRouting
ServerSearch
ServerTestMainGeotoolsRouting
ServerTestMainPostgresRouting
ServerTestMainRouting
SmartyResponseFormatter
SpaceManager
Step
StyledShape
StyleOverlay
TableElement
TableResultProvider
ToolTipsLayerBase
ToolTipsService
ToolTipsState
TwBin
TwBinHelper
TwClassification
TwClassificationHelper
TwColorRgb
TwColorRgbHelper
TwDistributionSummary
TwDistributionSummaryHelper
ViewsState
WmsBrowserLightState

Class: ServerHilight

Source Location: /plugins/hilight/server/ServerHilight.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ServerHilight

Hilighting server plugin

Variables

Methods

Inherited Variables

Class: ServerPlugin

ServerPlugin::$config
ServerPlugin::$serverContext

Class: PluginBase

PluginBase::$basePath
PluginBase::$name
PluginBase::$overriddenRequest

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 41]
Hilighting server plugin

This plugin is a service server plugin, it doesn't implement any interfaces and doesn't have a client side. Vector hilighting is used by ServerQuery.




[ Top ]

Class Variables

$log =

[line 46]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]


Class Methods

constructor __construct [line 51]

ServerHilight __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method buildExpression [line 61]

string buildExpression( QuerySelection $querySelection)

Builds a mapserver expression string



Tags:

return:  expression string
access:  protected


Parameters:

QuerySelection   $querySelection  

[ Top ]

method createHilightLayer [line 225]

MsLayer createHilightLayer( MsLayer $msLayer)

Create a new layer which is a copy of $msLayer, and change some of its attributes, to be hilighted

These attributes are read from metadata.




Tags:

access:  protected


Parameters:

MsLayer   $msLayer  

[ Top ]

method createLayer [line 189]

MsLayer createLayer( MsLayer $msLayer, string $defaultTrans, string $defaultColor, string $metaTrans, string $metaColor)

Copies a layer and sets some attributes



Tags:

return:  new layer
access:  protected


Parameters:

MsLayer   $msLayer   layer to be copied
string   $defaultTrans   transparency if not specified in source layer
string   $defaultColor   color if not specified in source layer
string   $metaTrans   meta data name for transparency
string   $metaColor   meta data name for color

[ Top ]

method createMaskLayer [line 252]

MsLayer createMaskLayer( MsLayer $msLayer)

Create a new layer which is a copy of $msLayer, and change some of its attributes, to be masked

These attributes are read from metadata.




Tags:

access:  protected


Parameters:

MsLayer   $msLayer  

[ Top ]

method hilightLayer [line 279]

void hilightLayer( QuerySelection $querySelection)

Main function, does hilight given a QuerySelection



Tags:

access:  public
see:  ServerQuery::handlePreDrawing()


Parameters:

QuerySelection   $querySelection  

[ Top ]

method hilightWholeLayer [line 236]

void hilightWholeLayer( MsLayer $layer, QuerySelection $querySelection)

Hilight a whole layer, by setting its classes to be hilighted



Tags:

access:  protected


Parameters:

MsLayer   $layer  
QuerySelection   $querySelection  

[ Top ]

method maskWholeLayer [line 263]

void maskWholeLayer( MsLayer $layer, QuerySelection $querySelection)

Mask a whole layer, by setting its classes to be masked



Tags:

access:  protected


Parameters:

MsLayer   $layer  
QuerySelection   $querySelection  

[ Top ]

method setClassExpression [line 159]

void setClassExpression( MsLayer $msLayer, int $classIndex, QuerySelection $querySelection)

Sets the expression of a mapserver class, so that it filters a given set of elements

These elements are specified in the QuerySelection.




Tags:

access:  protected


Parameters:

MsLayer   $msLayer   MapServer layer
int   $classIndex   index of layer's class
QuerySelection   $querySelection  

[ Top ]

method setHilightColor [line 119]

void setHilightColor( MsColor $colorObj, array $color)

Sets a color given in an array to a mapserver color object



Tags:

access:  protected


Parameters:

MsColor   $colorObj   MapServer color
array   $color   initial color (array(int red, int green, int blue))

[ Top ]

method setupHilightClass [line 129]

MsClass setupHilightClass( MsLayer $layer, MsClass $class)

Change the color and styles of this class to be hilighted



Tags:

return:  resulting class
access:  protected


Parameters:

MsLayer   $layer   layer
MsClass   $class   class to hilight

[ Top ]

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