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::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 Outline class



[ Top ]


Class Variables

$area =

[line 108]

Total shapes area



Tags:

access:  protected

Type:   double


[ Top ]

$log =

[line 97]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$outlineState =

[line 102]



Tags:

access:  protected

Type:   OutlineState


[ Top ]

$symbols =

[line 113]



Tags:

access:  protected

Type:   OutlineInit


[ Top ]



Class Methods


constructor __construct [line 124]

ClientOutline __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method adjustExportMapRequest [line 397]

void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)



Tags:

access:  public
see:  Exportable::adjustExportMapRequest


[ Top ]

method buildRequest [line 286]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method createSession [line 143]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawOutline [line 318]

string drawOutline( )

Draws Outline form and returns Smarty generated HTML



Tags:

access:  protected


[ Top ]

method drawOutlinelabel [line 360]

string drawOutlinelabel( )

Draws Outlinelabel form and returns Smarty generated HTML



Tags:

access:  protected


[ Top ]

method getTools [line 191]

array getTools( )

Returns outline tools : Point, Rectangle and Polygon



Tags:

return:  array of ToolDescription
access:  public


[ Top ]

method handleApplicationTool [line 185]

void handleApplicationTool( ToolDescription $tool)



Tags:

access:  public
see:  ToolProvider::handleApplicationTool()


[ Top ]

method handleHttpGetRequest [line 281]

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 handleInit [line 413]

void handleInit( mixed $outlineInit)



Tags:

access:  public
see:  InitUser::handleInit


[ Top ]

method handleKeymapTool [line 179]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)



Tags:

access:  public
see:  ToolProvider::handleKeymapTool()


[ Top ]

method handleMainmapTool [line 170]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)



Tags:

access:  public
see:  ToolProvider::handleMainmapTool()


[ Top ]

method handleResult [line 312]

void handleResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initializeResult [line 300]

void initializeResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 132]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 373]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method saveSession [line 160]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]

method setDefaultValues [line 420]

void setDefaultValues( mixed $valuesList)

Sets default values for outlines if none exist already



Tags:

access:  public


[ Top ]


Class Constants

TOOL_LINE =  'outline_line'

[line 116]


[ Top ]

TOOL_POINT =  'outline_point'

[line 115]


[ Top ]

TOOL_POLYGON =  'outline_poly'

[line 118]


[ Top ]

TOOL_RECTANGLE =  'outline_rectangle'

[line 117]


[ Top ]



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