CorePlugins
[ class tree: CorePlugins ] [ index: CorePlugins ] [ all elements ]
Packages:
CartoWeb3
Client
Common
CorePlugins
Plugins
Scripts
Server
Tests


Files:
ClientDemoLocation.php
ClientImages.php
ClientLayers.php
ClientLocation.php
ClientQuery.php
ClientStatictools.php
ClientTables.php
ClientTestMainLocation.php
Images.php
Layers.php
LayersInitProvider.php
Location.php
Query.php
ServerImages.php
ServerLayers.php
ServerLocation.php
ServerMapquery.php
ServerQuery.php
ServerTables.php
TableRulesRegistry.php
Tables.php

Classes:
BaseRule
BboxLocationCalculator
BboxLocationRequest
CellFilter
CellFilterBatch
CellRule
ClientDemoLocation
ClientImages
ClientLayers
ClientLocation
ClientQuery
ClientStatictools
ClientTables
ClientTestMainLocation
ColumnAdder
ColumnAdderBatch
ColumnFilter
ColumnPosition
ColumnReorder
ColumnRule
ColumnSelector
ColumnUnselector
GroupFilter
GroupRule
IdSelection
Image
Images
ImagesRequest
ImagesResult
ImagesState
LayerNode
LayersInit
LayersInitProvider
LayersRequest
LayersResult
LayersState
LocationCalculator
LocationConstraint
LocationInit
LocationRequest
LocationResult
LocationScale
LocationShortcut
LocationState
PanDirection
PanLocationCalculator
PanLocationRequest
QueryRequest
QueryResult
QuerySelection
QueryState
RecenterLocationCalculator
RecenterLocationRequest
RelativeLocationRequest
RowUnselector
ServerImages
ServerLayers
ServerLocation
ServerMapquery
ServerQuery
ServerTables
SwitchInit
Table
TableFilter
TableFlags
TableGroup
TableRow
TableRule
TableRulesRegistry
ZoomLocationRequest
ZoomPointLocationCalculator
ZoomPointLocationRequest

Class: ClientQuery

Source Location: /coreplugins/query/client/ClientQuery.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientQuery

Client part of Query plugin

Variables

Constants

Methods

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config

Class: PluginBase

PluginBase::$basePath
PluginBase::$name
PluginBase::$overriddenRequest

Inherited Methods

Class: ClientPlugin

ClientPlugin::__construct()
Constructor
ClientPlugin::checkBool()
Checks if variable $variable has a boolean (0 or 1) value $value.
ClientPlugin::checkInt()
Checks if variable $variable has an integer positive or zero value $value.
ClientPlugin::checkNumeric()
Checks if variable $variable has a numeric value $value.
ClientPlugin::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig()
Initializes plugin configuration

Class: PluginBase

PluginBase::__construct()
Constructor
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 47]
Client part of Query plugin



[ Top ]

Class Variables

$bbox =

[line 63]



Tags:

access:  protected

Type:   Bbox


[ Top ]

$log =

[line 53]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$queryState =

[line 58]



Tags:

access:  protected

Type:   QueryState


[ Top ]


Class Methods

method addDefaultQuerySelection [line 236]

void addDefaultQuerySelection( string $layerId)

Adds a QuerySelection with default values



Tags:

access:  protected


Parameters:

string   $layerId  

[ Top ]

method adjustExportMapRequest [line 580]

void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)



Tags:

access:  public
see:  Exportable::adjustExportMapRequest()


[ Top ]

method buildRequest [line 446]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method clearSession [line 113]

void clearSession( )

Reinitializes session content



Tags:

access:  protected


[ Top ]

method createSession [line 100]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

constructor __construct [line 82]

ClientQuery __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method drawQuery [line 528]

string drawQuery( )

Displays Query form



Tags:

return:  HTML generated by Smarty
access:  protected


[ Top ]

method findQuerySelection [line 221]

QuerySelection findQuerySelection( string $layerId)

Finds QuerySelection for a layer Id

Returns null if no QuerySelection was found.




Tags:

access:  protected


Parameters:

string   $layerId  

[ Top ]

method getLayers [line 178]

void getLayers( array &$queryLayers, array &$queryLayersLabel)

Returns layers Ids and labels from MapInfo



Tags:

access:  protected


Parameters:

array   &$queryLayers   layers
array   &$queryLayersLabel   layer labels

[ Top ]

method getTools [line 169]

void getTools( )



Tags:

access:  public
see:  ToolProvider::getTools()


[ Top ]

method handleApplicationTool [line 163]

void handleApplicationTool( ToolDescription $tool)



Tags:

access:  public
see:  ToolProvider::handleApplicationTool()


[ Top ]

method handleCompleteForm [line 350]

void handleCompleteForm( QueryRequest $request)

Handles parameters coming from complete form



Tags:

access:  protected


Parameters:

QueryRequest   $request  

[ Top ]

method handleHttpGetRequest [line 436]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 416]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleKeymapTool [line 157]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)



Tags:

access:  public
see:  ToolProvider::handleKeymapTool()


[ Top ]

method handleMainmapTool [line 138]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)



Tags:

access:  public
see:  ToolProvider::handleMainmapTool()


[ Top ]

method handleQuery [line 207]

void handleQuery( array $request, [boolean $check = false])

Handles variables that can be posted by POST or by GET



Tags:

access:  protected


Parameters:

array   $request  
boolean   $check  

[ Top ]

method handleResult [line 497]

void handleResult( mixed $queryResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method handleStandardParameters [line 276]

void handleStandardParameters( QueryRequest $request, [boolean $check = false])

Handles standard parameters



Tags:

access:  protected


Parameters:

QueryRequest   $request  
boolean   $check  

[ Top ]

method initializeResult [line 484]

void initializeResult( mixed $queryResult)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 90]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method processResult [line 506]

QueryResult processResult( QueryResult $queryResult)

Process a query result

Updates query selections depending on returned tables.




Tags:

access:  protected


Parameters:

QueryResult   $queryResult  

[ Top ]

method renderForm [line 573]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method saveSession [line 122]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]

Class Constants

DEFAULT_ATTRIBUTES =  true

[line 76]


[ Top ]

DEFAULT_HILIGHT =  true

[line 75]


[ Top ]

DEFAULT_MASKMODE =  false

[line 74]


[ Top ]

DEFAULT_POLICY =  QuerySelection::POLICY_XOR

[line 73]

Default flags for queries


[ Top ]

DEFAULT_TABLE =  true

[line 77]


[ Top ]

TOOL_QUERY =  'query'

[line 68]

Query tool name


[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:43:40 +0100 by phpDocumentor 1.3.0RC3