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

Class: ClientLocate

Source Location: /plugins/locate/client/ClientLocate.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientLocate

Locate web service


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 29]
Locate web service



[ Top ]


Class Variables

$log =

[line 34]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]



Class Methods


constructor __construct [line 39]

ClientLocate __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method drawLocate [line 106]

string drawLocate( )

Draws locate specific template



Tags:

return:  fetched template
access:  protected


[ Top ]

method drawLocateUlLi [line 126]

void drawLocateUlLi( array $result)

Generates HTML code for dropdown element (autocompleter)



Tags:

access:  public


Parameters:

array   $result   Array of results (key[0] means id, key[1] means title)

[ Top ]

method getList [line 50]

array getList( string $layerId, string $substr)

Retrieves list of records



Tags:

return:  Db result array
access:  private


Parameters:

string   $layerId   Layer id
string   $substr   feature name

[ Top ]

method handleHttpGetRequest [line 84]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 79]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method renderForm [line 117]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]


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