Class: ClientDemoLocation

Source Location: /projects/demoPlugins/coreplugins/demoLocation/client/ClientDemoLocation.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientLocation
         |
         --ClientDemoLocation

Client part of Entension of Location Coreplugin

Variables

Methods

Inherited Constants

Class: ClientLocation

ClientLocation::TOOL_FULLEXTENT
ClientLocation::TOOL_PAN
ClientLocation::TOOL_ZOOMIN
ClientLocation::TOOL_ZOOMOUT

Inherited Variables

Inherited Methods

Class: ClientLocation

ClientLocation::__construct(): Constructor
ClientLocation::adjustExportMapRequest()
ClientLocation::buildRequest()
ClientLocation::buildZoomPointRequest(): Constructs a ZoomPointLocationRequest
ClientLocation::createSession()
ClientLocation::drawIdRecenter(): Draws recenter on Ids form
ClientLocation::drawRecenter(): Draws recenter form
ClientLocation::drawScales(): Draws scales form
ClientLocation::drawShortcuts(): Draws shortcuts form
ClientLocation::getCurrentScale(): Returns current scale
ClientLocation::getLocation(): Returns current bbox
ClientLocation::getLocationInformation(): Returns a string with some location information (scale, bbox, etc.)
ClientLocation::getShortcuts(): Returns shortcuts
ClientLocation::getTools()
ClientLocation::getZoomInFactor(): Returns zoom factor depending on selected rectangle
ClientLocation::handleApplicationTool()
ClientLocation::handleBboxRecenter(): Handles recenter on bbox HTTP request
ClientLocation::handleFullExtent(): Handles full extent
ClientLocation::handleHttpGetRequest()
ClientLocation::handleHttpPostRequest()
ClientLocation::handleIdRecenter(): Handles recenter on Ids HTTP request
ClientLocation::handleInit()
ClientLocation::handleKeymapButton(): Handles clicks on key map
ClientLocation::handleKeymapTool()
ClientLocation::handleMainmapTool()
ClientLocation::handlePanButtons(): Handles panning buttons
ClientLocation::handleRecenterScales(): Handles recenter/scales HTTP request
ClientLocation::handleResult()
ClientLocation::handleShortcuts(): Handles shortcuts HTTP request
ClientLocation::initializeResult()
ClientLocation::loadSession()
ClientLocation::panDirectionToFactor(): Transforms PanDirection orientation to increments
ClientLocation::renderForm()
ClientLocation::saveSession()

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 30]
Client part of Entension of Location Coreplugin

[ Top ]

Class Variables

$extent =

[line 67]

Tags:

access:

protected

Type:

Bbox

[ Top ]

$idRecenterActive = false

[line 46]

@ var boolean

Tags:

access:

protected

Type:

mixed

[ Top ]

$idRecenterIdsList =

[line 52]

List of names

Tags:

access:

protected

Type:

array

[ Top ]

$idRecenterLayer = ''

[line 62]

Tags:

access:

protected

Type:

string

[ Top ]

$inputNameRecenter = ''

[line 41]

Input text

Tags:

access:

protected

Type:

string

[ Top ]

$log =

[line 35]

@ var Logger

Tags:

access:

private

Type:	mixed
Overrides:	Array

[ Top ]

$nbResults = 0

[line 57]

Tags:

access:

protected

Type:

integer

[ Top ]

Class Methods

constructor __construct [line 72]

ClientDemoLocation __construct(
)

Constructor

Tags:

access:

public

Overrides ClientLocation::__construct() (Constructor)

[ Top ]

method drawIdRecenter [line 242]

void drawIdRecenter(
)

Tags:

access:	protected
see:	ClientLocation::drawIdRecenter()

Overrides ClientLocation::drawIdRecenter() (Draws recenter on Ids form)

[ Top ]

method getDb [line 88]

void getDb(
boolean
0)

Database connection

Tags:

access:

protected

Parameters:

boolean

[ Top ]

method getLayerMeta [line 104]

array getLayerMeta(
array
$idRecenterLayer)

Retrieves id and name attributes of desired layer from metadata

Tags:

access:

protected

Parameters:

array

$idRecenterLayer

array of layers

[ Top ]

method handleIdRecenter [line 169]

void handleIdRecenter(
mixed
$request, [mixed
$check = false])

Tags:

access:	protected
see:	ClientLocation::handleIdRecenter()

Overrides ClientLocation::handleIdRecenter() (Handles recenter on Ids HTTP request)

[ Top ]

method handleInit [line 126]

void handleInit(
mixed
$locationInit)

Tags:

access:	public
see:	InitUser::handleInit()

Overrides ClientLocation::handleInit() (parent method not documented)

[ Top ]

method namesList [line 136]

array namesList(
mixed
$idRecenterLayer, mixed
$inputNameRecenter)

Retrieves list of names from database

Tags:

access:

protected

[ Top ]

method replacePlugin [line 80]

void replacePlugin(
)

Tags:

access:	public
see:	PluginManager::replacePlugin()

Overrides PluginBase::replacePlugin() (Returns name of parent plugin in case of plugin extension)

[ Top ]

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