Plugins

# Class: ClientOutline Source Location: /plugins/outline/client/ClientOutline.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ClientOutline
Client Outline class | ### Variables $area $geomType $log $outlineState $symbols | ### Constants TOOL_LINE TOOL_POINT TOOL_POLYGON TOOL_RECTANGLE | ### Methods __construct adjustExportMapRequest ajaxGetPluginResponse ajaxHandleAction buildRequest createSession drawOutline drawOutlinelabel filterGetRequest filterPostRequest getShape getTools handleApplicationTool handleHttpGetRequest handleHttpPostRequest handleInit handleKeymapTool handleMainmapTool handleResult handleShape hasShapes initializeResult loadSession renderForm renderFormPrepare saveSession setDefaultValues
### 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::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 Outline class [ Top ] ### Class Variables #### $area = [line 108] Total shapes area #### Tags:
access: | protected
Type: | double
[ Top ] #### $geomType = [line 118] #### Tags:
var: | geometry type
access: | protected
Type: | string
[ 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 128]
`ClientOutline __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method adjustExportMapRequest [line 498]
`void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)`
#### Tags:
access: | public
see: | Exportable::adjustExportMapRequest
[ Top ] ### method ajaxGetPluginResponse [line 472]
`void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)`
#### Tags:
access: | public
see: | Ajaxable::ajaxGetPluginResponse()
[ Top ] ### method ajaxHandleAction [line 480]
`void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)`
#### Tags:
access: | public
see: | Ajaxable::ajaxHandleAction()
[ Top ] ### method buildRequest [line 347]
`void buildRequest( )`
#### Tags:
access: | public
see: | ServerCaller::buildRequest()
[ Top ] ### method createSession [line 147]
`void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)`
#### Tags:
access: | public
see: | Sessionable::createSession()
[ Top ] ### method drawOutline [line 379]
`string drawOutline( )`
Draws Outline form and returns Smarty generated HTML #### Tags:
access: | protected
[ Top ] ### method drawOutlinelabel [line 423]
`string drawOutlinelabel( )`
Draws Outlinelabel form and returns Smarty generated HTML #### Tags:
access: | protected
[ Top ] ### method filterGetRequest [line 211]
`void filterGetRequest( FilterRequestModifier $request)`
#### Tags:
access: | public
see: | FilterProvider::filterGetRequest()
[ Top ] ### method filterPostRequest [line 206]
`void filterPostRequest( FilterRequestModifier $request)`
#### Tags:
access: | public
see: | FilterProvider::filterPostRequest()
[ Top ] ### method getShape [line 576]
`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 195]
`array getTools( )`
Returns outline tools : Point, Rectangle and Polygon #### Tags:
return: | array of ToolDescription
access: | public
[ Top ] ### method handleApplicationTool [line 189]
`void handleApplicationTool( ToolDescription $tool)`
#### Tags:
access: | public
see: | ToolProvider::handleApplicationTool()
[ Top ] ### method handleHttpGetRequest [line 289]
`void handleHttpGetRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
[ Top ] ### method handleHttpPostRequest [line 242]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method handleInit [line 514]
`void handleInit( mixed $outlineInit)`
#### Tags:
access: | public
see: | InitUser::handleInit
[ Top ] ### method handleKeymapTool [line 183]
`void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)`
#### Tags:
access: | public
see: | ToolProvider::handleKeymapTool()
[ Top ] ### method handleMainmapTool [line 174]
`void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)`
#### Tags:
access: | public
see: | ToolProvider::handleMainmapTool()
[ Top ] ### method handleResult [line 373]
`void handleResult( mixed $outlineResult)`
#### Tags:
access: | public
see: | ServerCaller::handleResult()
[ Top ] ### method handleShape [line 305]
`void handleShape( mixed $shape, mixed $request)`
common new shape handling for HttpPostRequet and HttpGetRequest #### Tags:
access: | protected
[ Top ] ### method hasShapes [line 565]
`boolean hasShapes( )`
Tells if shapes are stored in session. #### Tags:
access: | public
[ Top ] ### method initializeResult [line 361]
`void initializeResult( mixed $outlineResult)`
#### Tags:
access: | public
see: | ServerCaller::initializeResult()
[ Top ] ### method loadSession [line 136]
`void loadSession( mixed $sessionObject)`
#### Tags:
access: | public
see: | Sessionable::loadSession()
[ Top ] ### method renderForm [line 465]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method renderFormPrepare [line 438]
`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 164]
`void saveSession( )`
#### Tags:
access: | public
see: | Sessionable::saveSession()
[ Top ] ### method setDefaultValues [line 521]
`void setDefaultValues( mixed $valuesList)`
Sets default values for outlines if none exist already #### Tags:
access: | public
[ Top ] ### Class Constants #### TOOL_LINE = 'outline_line' [line 121] [ Top ] #### TOOL_POINT = 'outline_point' [line 120] [ Top ] #### TOOL_POLYGON = 'outline_poly' [line 123] [ Top ] #### TOOL_RECTANGLE = 'outline_rectangle' [line 122] [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:39 +0200 by phpDocumentor 1.3.0RC3