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

Class: ServerQuery

Source Location: /coreplugins/query/server/ServerQuery.php

Class Overview

PluginBase
   |
   --ServerPlugin
      |
      --ClientResponderAdapter
         |
         --ServerQuery

Server part of Query plugin


Variables

Constants

Methods


Inherited Variables

Inherited Methods


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 51]

ServerQuery __construct( )

Constructor



Tags:

access:  public


Overrides ServerPlugin::__construct() (Constructor)

[ Top ]

method drawQuery [line 94]

boolean drawQuery( )

Returns true if query results must be drawn using Mapserver



Tags:

access:  public


[ Top ]

method getAttributes [line 61]

array getAttributes( string $layerId)

Returns list of attributes to be returned



Tags:

access:  protected


Parameters:

string   $layerId   layer id

[ Top ]

method handlePreDrawing [line 401]

void handlePreDrawing( mixed $requ)



Tags:

access:  public
see:  ClientResponder::handlePreDrawing()


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

[ Top ]

method hilight [line 335]

void hilight( array $tables, array $hilightQuerySelections, [mixed $mayFail = false])

Hilights query



Tags:

access:  protected


Parameters:

array   $tables   tables
array   $hilightQuerySelections  

[ Top ]

method mergeTables [line 180]

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 233]

Table queryLayer( Shape $shape, QuerySelection $querySelection, [mixed $mayFail = false])

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 107]

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 ]


Class Constants

DATA_ENCODING =  'data_encoding'

[line 46]


[ Top ]

ID_ATTRIBUTE_STRING =  'id_attribute_string'

[line 44]

metadata parameters


[ Top ]

RETURNED_ATTRIBUTES_METADATA_NAME =  'query_returned_attributes'

[line 45]


[ Top ]



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