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

Class: ClientDemoRouting

Source Location: /projects/demoPlugins/plugins/demoRouting/client/ClientDemoRouting.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientRouting
         |
         --ClientDemoRouting

Example client routing plugin which uses Postgres


Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: ClientRouting

ClientRouting::__construct()
Constructor
ClientRouting::buildRequest()
ClientRouting::createSession()
ClientRouting::drawRouting()
Draws routing specific template
ClientRouting::handleHttpGetRequest()
ClientRouting::handleHttpPostRequest()
ClientRouting::handleResult()
ClientRouting::initializeResult()
ClientRouting::loadSession()
ClientRouting::renderForm()
ClientRouting::saveSession()

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 28]
Example client routing plugin which uses Postgres



[ Top ]


Class Variables

$log =

[line 33]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$vertices_options =

[line 39]

List of possible towns



Tags:

access:  protected

Type:   array


[ Top ]



Class Methods


constructor __construct [line 44]

ClientDemoRouting __construct( )

Constructor



Tags:

access:  public


Overrides ClientRouting::__construct() (Constructor)

[ Top ]

method drawRouting [line 98]

void drawRouting( )



Tags:

access:  protected
see:  ClientRouting::drawRouting()


Overrides ClientRouting::drawRouting() (Draws routing specific template)

[ Top ]

method getDb [line 62]

void getDb( boolean 0)

Database connection



Tags:

access:  protected


Parameters:

boolean   0  

[ Top ]

method replacePlugin [line 54]

void replacePlugin( )



Tags:

access:  public
see:  PluginManager::replacePlugin()


Overrides PluginBase::replacePlugin() (Returns name of parent plugin in case of plugin extension)

[ Top ]

method TownsList [line 75]

array TownsList( )

Retrieves list of names from database



Tags:

access:  protected


[ Top ]


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