Plugins
[ class tree: Plugins ] [ index: Plugins ] [ all elements ]

Class: ClientOutline

Source Location: /plugins/outline/client/ClientOutline.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientOutline

Client Outline class


Variables

Constants

Methods


Inherited Variables

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::replacePlugin()
Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 53]
Client Outline class



[ Top ]


Class Variables

$area =

[line 71]

Total shapes area



Tags:

access:  private

Type:   double


[ Top ]

$log =

[line 60]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$outlineState =

[line 65]



Tags:

access:  private

Type:   OutlineState


[ Top ]



Class Methods


constructor __construct [line 81]

ClientOutline __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method adjustExportMapRequest [line 275]

void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)



Tags:

access:  public
see:  Exportable::adjustExportMapRequest


[ Top ]

method buildMapRequest [line 214]

void buildMapRequest( mixed $mapRequest)



Tags:

access:  public
see:  ServerCaller::buildMapRequest()


[ Top ]

method createSession [line 96]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawOutline [line 243]

string drawOutline( )

Draws Outline form and returns Smarty generated HTML



Tags:

access:  private


[ Top ]

method drawOutlinelabel [line 255]

string drawOutlinelabel( )

Draws Outlinelabel form and returns Smarty generated HTML



Tags:

access:  private


[ Top ]

method getTools [line 134]

array getTools( )

Returns outline tools : Point, Rectangle and Polygon



Tags:

return:  array of ToolDescription
access:  public


[ Top ]

method handleHttpGetRequest [line 208]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 182]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleKeymapTool [line 125]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)



Tags:

access:  public
see:  ToolProvider::handleKeymapTool()


[ Top ]

method handleMainmapTool [line 116]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)



Tags:

access:  public
see:  ToolProvider::handleMainmapTool()


[ Top ]

method handleResult [line 237]

void handleResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initializeResult [line 227]

void initializeResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 89]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 263]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method saveSession [line 109]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]


Class Constants

TOOL_LINE =  'outline_line'

[line 74]


[ Top ]

TOOL_POINT =  'outline_point'

[line 73]


[ Top ]

TOOL_POLYGON =  'outline_poly'

[line 76]


[ Top ]

TOOL_RECTANGLE =  'outline_rectangle'

[line 75]


[ Top ]



Documentation generated on Wed, 6 Apr 2005 12:06:33 +0200 by phpDocumentor 1.3.0RC3