CorePlugins

# Class: ServerQuery Source Location: /coreplugins/query/server/ServerQuery.php
### Class Overview
    PluginBase
       |
       --ServerPlugin
          |
          --ClientResponderAdapter
             |
             --ServerQuery
Server part of Query plugin | ### Variables $drawQuery $log | ### Methods __construct drawQuery getAttributes handlePreDrawing hilight mergeTables queryLayer resultToTable
### 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 28] Server part of Query plugin [ Top ] ### Class Variables #### $drawQuery = false [line 39] Tells if query must be drawn by Mapserver #### Tags:
access: | protected
Type: | boolean
[ Top ] #### $log = [line 33] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] ### Class Methods ### constructor __construct [line 44]
`ServerQuery __construct( )`
Constructor #### Tags:
access: | public
Overrides ServerPlugin::__construct() (Constructor) [ Top ] ### method drawQuery [line 89]
`boolean drawQuery( )`
Returns true if query results must be drawn using Mapserver #### Tags:
access: | public
[ Top ] ### method getAttributes [line 54]
`array getAttributes( string $layerId)`
Returns list of attributes to be returned #### Tags:
access: | protected
#### Parameters:
string | $layerId | layer id
[ Top ] ### method handlePreDrawing [line 390]
`void handlePreDrawing( mixed $requ)`
#### Tags:
access: | public
see: | ClientResponder::handlePreDrawing()
Overrides ClientResponderAdapter::handlePreDrawing() (parent method not documented) [ Top ] ### method hilight [line 325]
`void hilight( array $tables, array $hilightQuerySelections)`
Hilights query #### Tags:
access: | protected
#### Parameters:
array | $tables | tables
array | $hilightQuerySelections |
[ Top ] ### method mergeTables [line 171]
`Table mergeTables( Table $table1, Table $table2, string $policy)`
Merges two tables #### Tags:
access: | protected
#### Parameters:
Table | $table1 |
Table | $table2 |
string | $policy | merge policy
[ Top ] ### method queryLayer [line 224]
`Table queryLayer( Shape $shape, QuerySelection $querySelection)`
Executes query on layer Query can be done using a Shape, a list of Ids, or both #### Tags:
access: | protected
#### Parameters:
Shape | $shape |
QuerySelection | $querySelection |
[ Top ] ### method resultToTable [line 102]
`Table resultToTable( array $result, string $layerId, string $idAttribute, array $attributes, TableFlags $tableFlags)`
Converts a Mapserver query result to a Table #### Tags:
access: | protected
#### Parameters:
array | $result |
string | $layerId |
string | $idAttribute |
array | $attributes | array of attributes
TableFlags | $tableFlags |
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:31:06 +0200 by phpDocumentor 1.3.0RC3