Class: ClientQuery

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

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientQuery

Client part of Query plugin

Variables

Constants

Methods

Inherited Constants

Class: ClientPlugin

ClientPlugin::ENABLE_LEVEL_FULL
ClientPlugin::ENABLE_LEVEL_LOAD
ClientPlugin::ENABLE_LEVEL_PROCESS
ClientPlugin::ENABLE_LEVEL_SERVERCALL

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config
ClientPlugin::$enabledLevel

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::disable(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_SERVERCALL.
ClientPlugin::enable(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getEnabledLevel(): Returns the enable level.
ClientPlugin::getHttpValue(): Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig(): Initializes plugin configuration
ClientPlugin::isEnabledAtLevel(): Sets the enable level to ClientPlugin::ENABLE_LEVEL_FULL.
ClientPlugin::setEnableLevel(): Sets the enable level (to be used with the AJAX mode).

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 47]
Client part of Query plugin

[ Top ]

Class Variables

$log =

[line 53]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$queryState =

[line 58]

Tags:

access:

protected

Type:

QueryState

[ Top ]

$shape =

[line 63]

Tags:

access:

protected

Type:

Shape

[ Top ]

Class Methods

method addDefaultQuerySelection [line 231]

void addDefaultQuerySelection(
string
$layerId)

Adds a QuerySelection with default values

Tags:

access:

protected

Parameters:

string

$layerId

[ Top ]

method adjustExportMapRequest [line 604]

void adjustExportMapRequest(
ExportConfiguration
$configuration, MapRequest
$mapRequest)

Tags:

access:	public
see:	Exportable::adjustExportMapRequest()

[ Top ]

method ajaxGetPluginResponse [line 575]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 582]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginsDirectives)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method buildRequest [line 441]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method clearSession [line 116]

void clearSession(
)

Reinitializes session content

Tags:

access:

protected

[ Top ]

method createSession [line 103]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Tags:

access:	public
see:	Sessionable::createSession()

[ Top ]

constructor __construct [line 85]

ClientQuery __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method drawQuery [line 523]

string drawQuery(
)

Displays Query form

Tags:

return:	HTML generated by Smarty
access:	protected

[ Top ]

method findQuerySelection [line 216]

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

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

void getTools(
)

Tags:

access:	public
see:	ToolProvider::getTools()

[ Top ]

method handleApplicationTool [line 155]

void handleApplicationTool(
ToolDescription
$tool)

Tags:

access:	public
see:	ToolProvider::handleApplicationTool()

[ Top ]

method handleCompleteForm [line 345]

void handleCompleteForm(
QueryRequest
$request)

Handles parameters coming from complete form

Tags:

access:

protected

Parameters:

QueryRequest

$request

[ Top ]

method handleHttpGetRequest [line 431]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 411]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleKeymapTool [line 149]

void handleKeymapTool(
ToolDescription
$tool, Shape
$keymapShape)

Tags:

access:	public
see:	ToolProvider::handleKeymapTool()

[ Top ]

method handleMainmapTool [line 141]

void handleMainmapTool(
ToolDescription
$tool, Shape
$mainmapShape)

Tags:

access:	public
see:	ToolProvider::handleMainmapTool()

[ Top ]

method handleQuery [line 202]

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

void handleResult(
mixed
$queryResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method handleStandardParameters [line 271]

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

Handles standard parameters

Tags:

access:

protected

Parameters:

QueryRequest	$request
boolean	$check

[ Top ]

method initializeResult [line 479]

void initializeResult(
mixed
$queryResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method loadSession [line 93]

void loadSession(
mixed
$sessionObject)

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method processResult [line 501]

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

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method saveSession [line 125]

void saveSession(
)

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

Class Constants

DEFAULT_ATTRIBUTES = true

[line 79]

[ Top ]

DEFAULT_HILIGHT = true

[line 78]

[ Top ]

DEFAULT_MASKMODE = false

[line 77]

[ Top ]

DEFAULT_POLICY = QuerySelection::POLICY_XOR

[line 76]

Default flags for queries

[ Top ]

DEFAULT_TABLE = true

[line 80]

[ Top ]

TOOL_QUERY_BY_BBOX = 'query_by_bbox'

[line 69]

[ Top ]

TOOL_QUERY_BY_CIRCLE = 'query_by_circle'

[line 71]

[ Top ]

TOOL_QUERY_BY_POINT = 'query_by_point'

[line 68]

Query tool name

[ Top ]

TOOL_QUERY_BY_POLYGON = 'query_by_polygon'

[line 70]

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:30:42 +0200 by phpDocumentor 1.3.0RC3