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


Files:
ClientDemoLocation.php
ClientImages.php
ClientLayers.php
ClientLocation.php
ClientQuery.php
ClientStatictools.php
ClientTables.php
ClientTestMainLocation.php
Images.php
Layers.php
LayersInitProvider.php
Location.php
Query.php
ServerImages.php
ServerLayers.php
ServerLocation.php
ServerMapquery.php
ServerQuery.php
ServerTables.php
TableRulesRegistry.php
Tables.php

Classes:
BaseRule
BboxLocationCalculator
BboxLocationRequest
CellFilter
CellFilterBatch
CellRule
ClientDemoLocation
ClientImages
ClientLayers
ClientLocation
ClientQuery
ClientStatictools
ClientTables
ClientTestMainLocation
ColumnAdder
ColumnAdderBatch
ColumnFilter
ColumnPosition
ColumnReorder
ColumnRule
ColumnSelector
ColumnUnselector
GroupFilter
GroupRule
IdSelection
Image
Images
ImagesRequest
ImagesResult
ImagesState
LayerNode
LayersInit
LayersInitProvider
LayersRequest
LayersResult
LayersState
LocationCalculator
LocationConstraint
LocationInit
LocationRequest
LocationResult
LocationScale
LocationShortcut
LocationState
PanDirection
PanLocationCalculator
PanLocationRequest
QueryRequest
QueryResult
QuerySelection
QueryState
RecenterLocationCalculator
RecenterLocationRequest
RelativeLocationRequest
RowUnselector
ServerImages
ServerLayers
ServerLocation
ServerMapquery
ServerQuery
ServerTables
SwitchInit
Table
TableFilter
TableFlags
TableGroup
TableRow
TableRule
TableRulesRegistry
ZoomLocationRequest
ZoomPointLocationCalculator
ZoomPointLocationRequest

Class: ServerLayers

Source Location: /coreplugins/layers/server/ServerLayers.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ClientResponderAdapter
         |
         --ServerLayers

Server plugin for managing the set of layers to render.

Variables

Methods

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::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 30]
Server plugin for managing the set of layers to render.



[ Top ]

Class Variables

$imageType =

[line 48]

Image type to use for images (outputformat identifier declared in mapfile). May be null to use default one.



Tags:

access:  protected

Type:   string


[ Top ]

$log =

[line 35]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$requestedLayerNames =

[line 41]

The list of layers requested to be drawn by the client.



Tags:

var:  Array of string
access:  protected

Type:   array


[ Top ]

$resRatio =

[line 54]

Ratio client-required resolution / Mapserver resolution.



Tags:

access:  protected

Type:   float


[ Top ]

$switchId =

[line 59]

Current switch



Tags:

access:  protected

Type:   mixed


[ Top ]


Class Methods

constructor __construct [line 64]

ServerLayers __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method getImageType [line 85]

string getImageType( )

Returns the image type to use for drawing, or null to use mapfile one.



Tags:

access:  public


[ Top ]

method getInit [line 235]

void getInit( )



Tags:

access:  public
see:  InitProvider::getInit()


[ Top ]

method getRequestedLayerNames [line 76]

array getRequestedLayerNames( )

Returns the list of layers requested to be drawn by the client.



Tags:

access:  public


[ Top ]

method getResRatio [line 92]

float getResRatio( )



Tags:

return:  ratio client-required resolution / Mapserver resolution.
access:  public


[ Top ]

method getSwitchId [line 100]

string getSwitchId( )

Returns current switch



Tags:

access:  public


[ Top ]

method handleCorePlugin [line 194]

void handleCorePlugin( mixed $requ)



Tags:

access:  public
see:  CoreProvider::handleCorePlugin()


[ Top ]

method initializeRequest [line 107]

void initializeRequest( mixed $requ)



Tags:

access:  public
see:  ClientResponder::initializeRequest()


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

[ Top ]

method updateProperties [line 135]

void updateProperties( mixed $obj, array $properties, float $ratio)

Generic function to multiply integer properties of a php mapscript object of a given ratio.



Tags:

access:  protected


Parameters:

mixed   $obj   php mapscript object to update
array   $properties   array of numerical properties to update
float   $ratio   multiplicative coefficient

[ Top ]

method updateRatioParameters [line 156]

void updateRatioParameters( ms_layer_obj $layer, float $resRatio)

Updates mapfile objects (layers, classes, styles) properties according to the ratio between required resolution and mapserver one.



Tags:

access:  protected


Parameters:

ms_layer_obj   $layer   Mapserver layer object
float   $resRatio   resolutions ratio

[ Top ]

Documentation generated on Mon, 13 Feb 2006 11:44:06 +0100 by phpDocumentor 1.3.0RC3