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

Class: ServerMapquery

Source Location: /coreplugins/mapquery/server/ServerMapquery.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ServerMapquery

A service plugin to perform queries based on a set of selected id's


Author(s):

Variables

Methods


Inherited Variables

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 30]
A service plugin to perform queries based on a set of selected id's



Tags:

author:  Sylvain Pasche <sylvain.pasche@camptocamp.com>


[ Top ]


Class Variables

$log =

[line 35]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 40]

ServerMapquery __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method checkImplementedConnectionTypes [line 209]

void checkImplementedConnectionTypes( msLayer $msLayer)

Checks if layer's connection type is implemented



Tags:

access:  protected


Parameters:

msLayer   $msLayer  

[ Top ]

method databaseQueryString [line 76]

array databaseQueryString( string $idAttribute, string $idType, array $selectedIds)

Returns an array of query strings (for use in queryByAttributes), from a set of id's and an attribute name. This query string is to be used on database kind of layers.



Tags:

access:  protected


Parameters:

string   $idAttribute  
string   $idType  
array   $selectedIds  

[ Top ]

method extractResults [line 111]

array extractResults( msLayer $layerId, mixed $mayIgnore)

Extracts all shapes in the given msLayer, and returns them in an array



Tags:

return:  the array of result shapes in the given layer
access:  protected


Parameters:

msLayer   $layerId   the layer from which to retrieve shapes

[ Top ]

method genericQueryString [line 54]

array genericQueryString( string $idAttribute, string $idType, array $selectedIds)

Returns an array of query strings (for use in queryByAttributes), from a set of id's and an attribute name. This query string can be used in most case for layers.



Tags:

access:  protected


Parameters:

string   $idAttribute  
string   $idType  
array   $selectedIds  

[ Top ]

method isDatabaseLayer [line 97]

boolean isDatabaseLayer( msLayer $msLayer)

Returns true if layer is linked to a database



Tags:

access:  protected


Parameters:

msLayer   $msLayer  

[ Top ]

method queryByBbox [line 380]

array queryByBbox( string $layerId, Bbox $bbox)

Performs a query based on a bbox on a given layer DEPRECATED: this method should no more be used.

Use ServerMapquery::queryByShape() instead




Tags:

return:  an array of shapes
access:  public


Parameters:

string   $layerId   layerId
Bbox   $bbox  

[ Top ]

method queryByIdSelection [line 229]

array queryByIdSelection( IdSelection $idSelection, [boolean $mayFail = false])

Performs a query based on a set of selected id's on a given layer



Tags:

return:  an array of shapes
access:  public


Parameters:

IdSelection   $idSelection   The selection to use for the query. It contains a layer name and a set of id's
boolean   $mayFail   If true, a failure in the query is not fatal (empy array returned)

[ Top ]

method queryByMsShape [line 349]

array queryByMsShape( string $layerId, ms_shape_obj $shape)

Performs a query based on a MapServer ms_shape_obj object on a given layer.



Tags:

return:  an array of shapes
access:  public


Parameters:

string   $layerId   layerId
ms_shape_obj   $shape   geographic selection

[ Top ]

method queryByShape [line 279]

array queryByShape( string $layerId, Shape $shape)

Performs a query based on a Shape object on a given layer.



Tags:

return:  an array of shapes
access:  public


Parameters:

string   $layerId   layerId
Shape   $shape   geographic selection

[ Top ]

method queryLayerByAttributes [line 160]

array queryLayerByAttributes( ServerContext $serverContext, msLayer $layerId, string $idAttribute, string $query, [boolean $mayFail = false])

Performs a query on a layer using attributes



Tags:

return:  an array of shapes
access:  protected


Parameters:

ServerContext   $serverContext   Server context
msLayer   $layerId   Layer to query
string   $idAttribute   The attribute name used by the query
string   $query   The query string to perform
boolean   $mayFail   If true, a failure in the query is not fatal (empy array returned)

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:52 +0200 by phpDocumentor 1.3.0RC3