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 Constants

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::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 96]
Client Outline class



[ Top ]


Class Variables

$area =

[line 114]

Total shapes area



Tags:

access:  protected

Type:   double


[ Top ]

$geomType =

[line 124]



Tags:

var:  geometry type
access:  protected

Type:   string


[ Top ]

$log =

[line 103]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$outlineState =

[line 108]



Tags:

access:  protected

Type:   OutlineState


[ Top ]

$symbols =

[line 119]



Tags:

access:  protected

Type:   OutlineInit


[ Top ]



Class Methods


constructor __construct [line 135]

ClientOutline __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method addShapes [line 326]

void addShapes( mixed $type, mixed $request)



Tags:

access:  protected


[ Top ]

method adjustExportMapRequest [line 549]

void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)



Tags:

access:  public
see:  Exportable::adjustExportMapRequest


[ Top ]

method ajaxGetPluginResponse [line 522]

void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)



Tags:

access:  public
see:  Ajaxable::ajaxGetPluginResponse()


[ Top ]

method ajaxHandleAction [line 531]

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method buildRequest [line 393]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method createSession [line 154]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawOutline [line 425]

string drawOutline( )

Draws Outline form and returns Smarty generated HTML



Tags:

access:  protected


[ Top ]

method drawOutlinelabel [line 471]

string drawOutlinelabel( )

Draws Outlinelabel form and returns Smarty generated HTML



Tags:

access:  protected


[ Top ]

method filterGetRequest [line 219]

void filterGetRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  FilterProvider::filterGetRequest()


[ Top ]

method filterPostRequest [line 214]

void filterPostRequest( FilterRequestModifier $request)



Tags:

access:  public
see:  FilterProvider::filterPostRequest()


[ Top ]

method getShape [line 627]

Shape getShape( string $type, string $values)

Gets a geometry type (point, line, polygon)

and the points coordinates of the geometry




Tags:

access:  protected


Parameters:

string   $type   type : type of feature (polygon, line or point)
string   $values   values : list of point coordinates, x1,y1;x2,y2...

[ Top ]

method getTools [line 202]

array getTools( )

Returns outline tools : Point, Rectangle and Polygon



Tags:

return:  array of ToolDescription
access:  public


[ Top ]

method handleApplicationTool [line 196]

void handleApplicationTool( ToolDescription $tool)



Tags:

access:  public
see:  ToolProvider::handleApplicationTool()


[ Top ]

method handleHttpGetRequest [line 316]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 262]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleInit [line 565]

void handleInit( mixed $outlineInit)



Tags:

access:  public
see:  InitUser::handleInit


[ Top ]

method handleKeymapTool [line 190]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)



Tags:

access:  public
see:  ToolProvider::handleKeymapTool()


[ Top ]

method handleMainmapTool [line 182]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)



Tags:

access:  public
see:  ToolProvider::handleMainmapTool()


[ Top ]

method handleResult [line 419]

void handleResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method handleShape [line 346]

void handleShape( mixed $shape, mixed $request, [mixed $label = NULL])

common new shape handling for HttpPostRequet and HttpGetRequest



Tags:

access:  protected


[ Top ]

method hasShapes [line 616]

boolean hasShapes( )

Tells if shapes are stored in session.



Tags:

access:  public


[ Top ]

method initializeResult [line 407]

void initializeResult( mixed $outlineResult)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 143]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 515]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method renderFormPrepare [line 488]

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 172]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]

method setDefaultValues [line 572]

void setDefaultValues( mixed $valuesList)

Sets default values for outlines if none exist already



Tags:

access:  public


[ Top ]


Class Constants

TOOL_CIRCLE =  'outline_circle'

[line 130]


[ Top ]

TOOL_LINE =  'outline_line'

[line 127]


[ Top ]

TOOL_POINT =  'outline_point'

[line 126]


[ Top ]

TOOL_POLYGON =  'outline_poly'

[line 129]


[ Top ]

TOOL_RECTANGLE =  'outline_rectangle'

[line 128]


[ Top ]



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