Class: ClientGeoloc

Source Location: /plugins/geoloc/client/ClientGeoloc.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientGeoloc

This plugin let the user select a point on the map and recover the coordinate

Author(s):

Version:

$Id: ClientGeoloc.php,v 1.2 2009-03-27 10:45:34 ochriste Exp $

Copyright:

2005 Camptocamp SA

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::getFolderId(): get folder id if set in plugin config
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 24]
This plugin let the user select a point on the map and recover the coordinate

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Tags:

version:	$Id: ClientGeoloc.php,v 1.2 2009-03-27 10:45:34 ochriste Exp $
copyright:	2005 Camptocamp SA

[ Top ]

Class Variables

$Geo_x =

[line 36]

Tags:

var:	coordinates
access:	private

Type:

[ Top ]

$Geo_y =

[line 37]

Tags:

access:

private

Type:

mixed

[ Top ]

$log =

[line 31]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$pluginStatus =

[line 43]

Tags:

var:	status of the plugin, activated or not
access:	private

Type:

pluginStatus

[ Top ]

Class Methods

constructor __construct [line 48]

ClientGeoloc __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 159]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 166]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method createSession [line 67]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Reinitializes session-saved tool.

Tags:

access:	public
see:	Sessionable::createSession()

[ Top ]

method filterGetRequest [line 84]

void filterGetRequest(
FilterRequestModifier
$request)

Tags:

access:	public
see:	FilterProvider::filterGetRequest()

[ Top ]

method filterPostRequest [line 93]

void filterPostRequest(
FilterRequestModifier
$request)

Tags:

access:	public
see:	FilterProvider::filterPostRequest()

[ Top ]

method getTools [line 152]

void getTools(
)

Tags:

access:	public
see:	ToolProvider::getTools()

[ Top ]

method handleApplicationTool [line 147]

void handleApplicationTool(
ToolDescription
$tool)

Tags:

access:	public
see:	ToolProvider::handleApplicationTool()

[ Top ]

method handleHttpGetRequest [line 116]

void handleHttpGetRequest(
mixed
$request)

Recover the tool received via url

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 98]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleKeymapTool [line 142]

void handleKeymapTool(
ToolDescription
$tool, Shape
$keymapShape)

Tags:

access:	public
see:	ToolProvider::handleKeymapTool()

[ Top ]

method handleMainmapTool [line 137]

void handleMainmapTool(
ToolDescription
$tool, Shape
$mainmapShape)

Tags:

access:	public
see:	ToolProvider::handleMainmapTool()

[ Top ]

method loadSession [line 58]

void loadSession(
mixed
$sessionObject)

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method renderForm [line 130]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method renderFormPrepare [line 123]

array renderFormPrepare(
)

This method factors the plugin output for both GuiProvider::renderForm() and Ajaxable::ajaxGetPluginResponse().

Tags:

return:	array of variables and html code to be assigned
access:	protected

[ Top ]

method saveSession [line 75]

void saveSession(
)

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

Documentation generated on Fri, 24 May 2013 13:30:42 +0200 by phpDocumentor 1.3.0RC3