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

Class: ServerHilight

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

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ServerHilight

Hilighting server plugin


Variables

Methods


Inherited Variables

Inherited Methods


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:  private


Parameters:

QuerySelection   $querySelection  

[ Top ]

method createHilightLayer [line 217]

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:  private


Parameters:

MsLayer   $msLayer  

[ Top ]

method createLayer [line 181]

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

Copies a layer and sets some attributes



Tags:

return:  new layer
access:  private


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 244]

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:  private


Parameters:

MsLayer   $msLayer  

[ Top ]

method hilightLayer [line 271]

void hilightLayer( QuerySelection $querySelection)

Main function, does hilight given a QuerySelection



Tags:

access:  public
see:  ServerQuery::handlePreDrawing()


Parameters:

QuerySelection   $querySelection  

[ Top ]

method hilightWholeLayer [line 228]

void hilightWholeLayer( MsLayer $layer, QuerySelection $querySelection)

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



Tags:

access:  private


Parameters:

MsLayer   $layer  
QuerySelection   $querySelection  

[ Top ]

method maskWholeLayer [line 255]

void maskWholeLayer( MsLayer $layer, QuerySelection $querySelection)

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



Tags:

access:  private


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:  private


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:  private


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:  private


Parameters:

MsLayer   $layer   layer
MsClass   $class   class to hilight

[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:57 +0200 by phpDocumentor 1.3.0RC3