Server

# Class: ServerPlugin Source Location: /server/ServerPlugin.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
Server plugin #### Author(s): | ### Variables $config $log $serverContext | ### Methods __construct getConfig getServerContext initializeConfig useExtendedInit useExtendedRequest useExtendedResult
### Child classes: ClientResponderAdapter Adapter for interface ClientResponder ServerExportPdf Server part of ExportPdf plugin ServerAccounting Server part of Accounting plugin ServerHilight Hilighting server plugin ServerMapOverlay Server MapOverlay class ServerMapquery A service plugin to perform queries based on a set of selected id's ServerTables Server side of Tables plugin Plugin to test tables rules creation | ### Inherited Variables #### Class: PluginBase PluginBase::$basePath PluginBase::$name PluginBase::$overriddenRequest | ### Inherited Methods #### 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 88] Server plugin #### Tags:
abstract: |
[ Top ] ### Class Variables #### $config = [line 98] #### Tags:
access: | private
Type: | ServerPluginConfig
[ Top ] #### $log = [line 93] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $serverContext = [line 103] #### Tags:
access: | protected
Type: | ServerContext
[ Top ] ### Class Methods ### constructor __construct [line 108]
`ServerPlugin __construct( )`
Constructor #### Tags:
access: | public
Overridden in child classes as: ServerOutline::__construct() Constructor ServerGeostat::__construct() ServerOgcLayerLoader::__construct() Constructor ServerEdit::__construct() Constructor ServerLayerReorder::__construct() Constructor ServerRouting::__construct() Constructor ServerTestMainGeotoolsRouting::__construct() Constructor ServerProjectGeotoolsRouting::__construct() Constructor ServerPostgresRouting::__construct() Constructor ServerQuery::__construct() Constructor ServerLayers::__construct() Constructor ServerLocation::__construct() Constructor ServerImages::__construct() Constructor ServerProjectplugin::__construct() Constructor ServerProjectTable::__construct() Constructor ServerExportPdf::__construct() Constructor ServerAccounting::__construct() Constructor ServerHilight::__construct() Constructor ServerMapOverlay::__construct() Constructor ServerMapquery::__construct() Constructor ServerTables::__construct() Constructor ServerProjectTableRules::__construct() Constructor Overrides PluginBase::__construct() (Constructor) [ Top ] ### method getConfig [line 133]
`ServerConfig getConfig( )`
#### Tags:
access: | public
[ Top ] ### method getServerContext [line 115]
`ServerContext getServerContext( )`
#### Tags:
access: | public
[ Top ] ### method initializeConfig [line 123]
`void initializeConfig( ServerContext $initArgs)`
Initializes plugin configuration #### Tags:
access: | public
Overrides PluginBase::initializeConfig() (Initializes plugin) #### Parameters:
ServerContext | $initArgs |
[ Top ] ### method useExtendedInit [line 154]
`boolean useExtendedInit( )`
#### Tags:
access: | public
[ Top ] ### method useExtendedRequest [line 140]
`boolean useExtendedRequest( )`
#### Tags:
access: | public
Overridden in child classes as: ServerProjectLocation::useExtendedRequest() [ Top ] ### method useExtendedResult [line 147]
`boolean useExtendedResult( )`
#### Tags:
access: | public
Overridden in child classes as: ServerProjectLocation::useExtendedResult() [ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:05 +0200 by phpDocumentor 1.3.0RC3