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

Class: ClientLayerReorder

Source Location: /plugins/layerReorder/client/ClientLayerReorder.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientLayerReorder

Client layereReorder class


Variables

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 66]
Client layereReorder class



[ Top ]


Class Variables

$bottomLayers =

[line 124]

Layer order exclusion list to put on bottom of the stack



Tags:

access:  protected

Type:   mixed


[ Top ]

$layerIds =

[line 84]

Initial Ms Layers Ids array



Tags:

access:  protected

Type:   array


[ Top ]

$layerLabels =

[line 90]

Initial Layers Labels array sorted



Tags:

access:  protected

Type:   array


[ Top ]

$layerReorderState =

[line 114]

LayerReorder State object (session object)



Tags:

access:  protected

Type:   object


[ Top ]

$layerTransparencies =

[line 96]

Initial Layers Transparency array sorted



Tags:

access:  protected

Type:   array


[ Top ]

$layerUserTransparencies =

[line 102]

Layers user Transparency array indexed by msLayer name



Tags:

access:  public

Type:   array


[ Top ]

$log =

[line 72]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$orderedMsLayerIds =

[line 78]

Ms Layer Ids ordered



Tags:

access:  protected

Type:   array


[ Top ]

$selectedMsLayerIds =

[line 108]

Array of MapServer layers id selected (currently displayed)



Tags:

access:  protected

Type:   array


[ Top ]

$topLayers =

[line 119]

Layer order exclusion list to put on top of the stack



Tags:

access:  protected

Type:   mixed


[ Top ]

$transparencyLevels =

[line 129]

Transparency level array allowed for each Ms layer



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 135]

ClientLayerReorder __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method ajaxGetPluginResponse [line 502]

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

void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)



Tags:

access:  public
see:  Ajaxable::ajaxHandleAction()


[ Top ]

method buildRequest [line 251]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method createSession [line 146]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method getCloserTransparency [line 368]

int getCloserTransparency( int $transparency)

Return closer transparency value from available levels



Tags:

access:  public


Parameters:

int   $transparency   transparency transparency value in map file

[ Top ]

method getCwLayerIds [line 317]

array getCwLayerIds( )

Retrieve CW3 layer ids array, with for each the corresponding MapServer layer Id as value.



Tags:

access:  public


[ Top ]

method getOrderedMsLayerIds [line 308]

void getOrderedMsLayerIds( )



Tags:

access:  public


[ Top ]

method getRenderSelectedLayers [line 336]

array getRenderSelectedLayers( )

Return selected layer labels array, rightly ordered



Tags:

access:  protected


[ Top ]

method getSelectedMsIds [line 276]

array getSelectedMsIds( )

Retrieve selected layers MapServer Ids (rightly ordered)



Tags:

access:  protected


[ Top ]

method handleHttpGetRequest [line 411]

void handleHttpGetRequest( array $request)

Handles data coming from a get request



Tags:

access:  public


Parameters:

array   $request   HTTP request

[ Top ]

method handleHttpPostRequest [line 401]

void handleHttpPostRequest( array $request)

Handles data coming from a post request



Tags:

access:  public


Parameters:

array   $request   HTTP request

[ Top ]

method handleInit [line 190]

void handleInit( mixed $initObject)



Tags:

access:  public
see:  InitUser::handleInit()


[ Top ]

method handleRequest [line 421]

void handleRequest( array $request)

Common method to handle both Get or Post request



Tags:

access:  protected


Parameters:

array   $request   layers to reorder

[ Top ]

method handleResult [line 387]

void handleResult( mixed $layerReorderResult)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initializeResult [line 269]

void initializeResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 159]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 492]

void renderForm( Smarty $template)



Tags:

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


[ Top ]

method renderFormPrepare [line 468]

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 setMsLayerProperties [line 223]

void setMsLayerProperties( )

Sets mapfile layers properties



Tags:

access:  protected


[ Top ]


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