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

Class: ClientLocation

Source Location: /coreplugins/location/client/ClientLocation.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientLocation

Client part of Location plugin


Variables

Constants

Methods


Child classes:

ClientTestMainLocation
ClientProjectLocation
Client part of Location plugin, project test_project

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 53]
Client part of Location plugin



[ Top ]


Class Variables

$fullExtent =

[line 90]



Tags:

access:  protected

Type:   Bbox


[ Top ]

$locationRequest =

[line 70]



Tags:

access:  protected

Type:   LocationRequest


[ Top ]

$locationResult =

[line 75]



Tags:

access:  protected

Type:   LocationResult


[ Top ]

$locationState =

[line 65]



Tags:

access:  protected

Type:   LocationState


[ Top ]

$log =

[line 60]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$recenterDefaultScale =

[line 95]



Tags:

access:  protected

Type:   int


[ Top ]

$scales =

[line 80]



Tags:

access:  protected

Type:   array


[ Top ]

$shortcuts =

[line 85]



Tags:

access:  protected

Type:   array


[ Top ]

$smarty =

[line 108]



Tags:

access:  protected

Type:   Smarty_Plugin


[ Top ]



Class Methods


constructor __construct [line 113]

ClientLocation __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method adjustExportMapRequest [line 979]

void adjustExportMapRequest( ExportConfiguration $configuration, MapRequest $mapRequest)



Tags:

access:  public
see:  Exportable::adjustExportMapRequest()


[ Top ]

method ajaxGetPluginResponse [line 934]

void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)



Tags:

access:  public
see:  Ajaxable::ajaxGetPluginResponse() FIXME: when all the values in the $assignArray are to be assigned, 1354


[ Top ]

method ajaxHandleAction [line 947]

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method buildRequest [line 779]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


Overridden in child classes as:

ClientProjectLocation::buildRequest()

[ Top ]

method buildZoomPointRequest [line 695]

LocationRequest buildZoomPointRequest( string $zoomType, Point $point, [double $zoomFactor = 0], [double $scale = 0])

Constructs a ZoomPointLocationRequest



Tags:

access:  protected


Parameters:

string   $zoomType  
Point   $point  
double   $zoomFactor  
double   $scale  

[ Top ]

method createSession [line 584]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawIdRecenter [line 410]

string drawIdRecenter( )

Draws recenter on Ids form



Tags:

access:  protected


[ Top ]

method drawRecenter [line 314]

string drawRecenter( )

Draws recenter form



Tags:

access:  protected


[ Top ]

method drawScales [line 323]

string drawScales( )

Draws scales form



Tags:

access:  protected


[ Top ]

method drawShortcuts [line 485]

string drawShortcuts( )

Draws shortcuts form



Tags:

access:  protected


[ Top ]

method getCurrentScale [line 813]

float getCurrentScale( )

Returns current scale



Tags:

access:  public


[ Top ]

method getLocation [line 604]

Bbox getLocation( )

Returns current bbox



Tags:

access:  public


[ Top ]

method getLocationInformation [line 841]

string getLocationInformation( )

Returns a string with some location information (scale, bbox, etc.)



Tags:

access:  protected


[ Top ]

method getShortcuts [line 596]

array getShortcuts( )

Returns shortcuts



Tags:

return:  array of LocationShortcut
access:  public


[ Top ]

method getTools [line 763]

void getTools( )



Tags:

access:  public
see:  ToolProvider::getTools()


[ Top ]

method getZoomInFactor [line 672]

double getZoomInFactor( Rectangle $rectangle)

Returns zoom factor depending on selected rectangle



Tags:

access:  protected


Parameters:

Rectangle   $rectangle  

[ Top ]

method handleApplicationTool [line 754]

void handleApplicationTool( ToolDescription $tool)



Tags:

access:  public
see:  ToolProvider::handleApplicationTool()


[ Top ]

method handleBboxRecenter [line 506]

LocationRequest handleBboxRecenter( array $request, [boolean $check = false])

Handles recenter on bbox HTTP request



Tags:

access:  protected


Parameters:

array   $request   HTTP request
boolean   $check  

[ Top ]

method handleFullExtent [line 559]

LocationRequest handleFullExtent( )

Handles full extent



Tags:

access:  protected


[ Top ]

method handleHttpGetRequest [line 647]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 614]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleIdRecenter [line 351]

LocationRequest handleIdRecenter( array $request, [boolean $check = false])

Handles recenter on Ids HTTP request



Tags:

access:  protected


Parameters:

array   $request   HTTP request
boolean   $check  

[ Top ]

method handleInit [line 821]

void handleInit( mixed $locationInit)



Tags:

access:  public
see:  InitUser::handleInit()


[ Top ]

method handleKeymapButton [line 196]

LocationRequest handleKeymapButton( )

Handles clicks on key map



Tags:

access:  protected


[ Top ]

method handleKeymapTool [line 748]

void handleKeymapTool( ToolDescription $tool, Shape $keymapShape)



Tags:

access:  public
see:  ToolProvider::handleKeymapTool()


[ Top ]

method handleMainmapTool [line 718]

void handleMainmapTool( ToolDescription $tool, Shape $mainmapShape)



Tags:

access:  public
see:  ToolProvider::handleMainmapTool()


[ Top ]

method handlePanButtons [line 143]

LocationRequest handlePanButtons( )

Handles panning buttons



Tags:

access:  protected


[ Top ]

method handleRecenterScales [line 226]

LocationRequest handleRecenterScales( array $request, [boolean $useDoit = true], [mixed $check = false])

Handles recenter/scales HTTP request

When useDoit parameter is true, scale is changed only if a scale selection was done on form. In this case, a form value ("doit") is set to '1' using Javascript.




Tags:

access:  protected


Parameters:

array   $request   HTTP request
boolean   $useDoit  

[ Top ]

method handleResult [line 807]

void handleResult( mixed $locationResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method handleShortcuts [line 451]

LocationRequest handleShortcuts( array $request, [boolean $useDoit = true], [boolean $check = false])

Handles shortcuts HTTP request



Tags:

access:  protected


Parameters:

array   $request   HTTP request
boolean   $useDoit  
boolean   $check  

[ Top ]

method initializeResult [line 799]

void initializeResult( mixed $locationResult)



Tags:

access:  public
see:  ServerCaller::initializeResult()


Overridden in child classes as:

ClientProjectLocation::initializeResult()

[ Top ]

method loadSession [line 574]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method panDirectionToFactor [line 123]

int panDirectionToFactor( string $panDirection)

Transforms PanDirection orientation to increments



Tags:

access:  protected


Parameters:

string   $panDirection  

[ Top ]

method renderForm [line 922]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm() FIXME: when all the values in the $assignArray are to be assigned, 1354


Overridden in child classes as:

ClientProjectLocation::renderForm()

[ Top ]

method renderFormPrepare [line 866]

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

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]


Class Constants

TOOL_FULLEXTENT =  'fullextent'

[line 103]


[ Top ]

TOOL_PAN =  'pan'

[line 102]


[ Top ]

TOOL_ZOOMIN =  'zoomin'

[line 100]

Tool constants.


[ Top ]

TOOL_ZOOMOUT =  'zoomout'

[line 101]


[ Top ]



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