Class: ClientEdit

Source Location: /plugins/edit/client/ClientEdit.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientEdit

Client Edit class

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::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 90]
Client Edit class

[ Top ]

Class Variables

$editState =

[line 102]

Tags:

access:

protected

Type:

EditState

[ Top ]

$general =

[line 107]

Tags:

access:

protected

Type:

EditGeneral

[ Top ]

$log =

[line 97]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

Class Methods

constructor __construct [line 121]

ClientEdit __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method buildRequest [line 421]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method createSession [line 188]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Tags:

access:	public
see:	Sessionable::createSession()

[ Top ]

method filterGetRequest [line 145]

void filterGetRequest(
FilterRequestModifier
$request)

Tags:

access:

public

[ Top ]

method filterPostRequest [line 129]

void filterPostRequest(
FilterRequestModifier
$request)

Tags:

access:

public

[ Top ]

method getArrayFromIni [line 171]

array getArrayFromIni(
string
$name, [boolean
$simple = false])

Returns an array from a comma-separated list of a ini parameter.

Tags:

access:

protected

Parameters:

string	$name	name of ini parameter
boolean	$simple	(default: false) true: returns a simplified array

[ Top ]

method getArrayFromList [line 154]

array getArrayFromList(
array
$list, [boolean
$simple = false])

Returns an array from a comma-separated list string.

Tags:

access:

protected

Parameters:

array	$list
boolean	$simple	(default: false) true: returns a simplified array

[ Top ]

method getCurrentScale [line 289]

float getCurrentScale(
)

Retrieves current scale from location plugin

Tags:

access:

protected

[ Top ]

method getTools [line 524]

array getTools(
)

Returns the edit tool : Point, Line and Polygon

Corresponds to the shapeType of the editLayer

Tags:

return:	array of ToolDescription
access:	public
see:	ToolProvider::getTools()

[ Top ]

method handleApplicationTool [line 515]

void handleApplicationTool(
ToolDescription
$tool)

Tags:

access:	public
see:	ToolProvider::handleApplicationTool()

[ Top ]

method handleHttpGetRequest [line 276]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 202]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleKeymapTool [line 507]

void handleKeymapTool(
ToolDescription
$tool, Shape
$keymapShape)

Tags:

access:	public
see:	ToolProvider::handleKeymapTool()

[ Top ]

method handleMainmapTool [line 499]

void handleMainmapTool(
ToolDescription
$tool, Shape
$mainmapShape)

Tags:

access:	public
see:	ToolProvider::handleMainmapTool()

[ Top ]

method handleResult [line 468]

void handleResult(
mixed
$editResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method initializeResult [line 462]

void initializeResult(
mixed
$editResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method loadSession [line 181]

void loadSession(
mixed
$sessionObject)

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method renderForm [line 307]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method saveSession [line 195]

void saveSession(
)

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

method updateFeaturesArray [line 249]

void updateFeaturesArray(
mixed
$id, mixed
$value)

Updates the editState features array

Tags:

var:	feature id
access:	protected

[ Top ]

Class Constants

TOOL_ADD_VERTEX = 'edit_add_vertex'

[line 114]

[ Top ]

TOOL_DEL_FEATURE = 'edit_del_feature'

[line 116]

[ Top ]

TOOL_DEL_VERTEX = 'edit_del_vertex'

[line 113]

[ Top ]

TOOL_LINE = 'edit_line'

[line 110]

[ Top ]

TOOL_MOVE = 'edit_move'

[line 112]

[ Top ]

TOOL_POINT = 'edit_point'

[line 109]

[ Top ]

TOOL_POLYGON = 'edit_polygon'

[line 111]

[ Top ]

TOOL_SEL = 'edit_sel'

[line 115]

[ Top ]

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