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 Details

[line 29]
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 34]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 39]

ServerMapquery __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method checkImplementedConnectionTypes [line 192]

void checkImplementedConnectionTypes( msLayer $msLayer)

Checks if layer's connection type is implemented



Tags:

access:  private


Parameters:

msLayer   $msLayer  

[ Top ]

method databaseQueryString [line 75]

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


Parameters:

string   $idAttribute  
string   $idType  
array   $selectedIds  

[ Top ]

method extractResults [line 97]

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


Parameters:

msLayer   $layerId   the layer from which to retrieve shapes

[ Top ]

method genericQueryString [line 53]

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


Parameters:

string   $idAttribute  
string   $idType  
array   $selectedIds  

[ Top ]

method isDatabaseLayer [line 88]

boolean isDatabaseLayer( msLayer $msLayer)

Returns true if layer is linked to a database



Tags:

access:  private


Parameters:

msLayer   $msLayer  

[ Top ]

method queryByBbox [line 260]

array queryByBbox( string $layerId, Bbox $bbox)

Performs a query based on a bbox on a given layer



Tags:

return:  an array of shapes
access:  public


Parameters:

string   $layerId   layerId
Bbox   $bbox  

[ Top ]

method queryByIdSelection [line 211]

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 queryLayerByAttributes [line 146]

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


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 Wed, 6 Apr 2005 12:06:59 +0200 by phpDocumentor 1.3.0RC3