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

Class: ClientRouting

Source Location: /plugins/routing/client/ClientRouting.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientRouting



Variables

Methods


Child classes:

ClientDemoRouting
Example client routing plugin which uses Postgres

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::getCartoclient()
ClientPlugin::getConfig()
ClientPlugin::getHttpValue()
Returns the user-submitted $key data if it is set.
ClientPlugin::initializeConfig()
Initializes plugin configuration

Class: PluginBase

PluginBase::__construct()
Constructor
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 59]


[ Top ]


Class Variables

$doRouting =

[line 75]



Tags:

access:  protected

Type:   boolean


[ Top ]

$log =

[line 65]



Tags:

access:  private

Type:   Logger
Overrides:   Array


[ Top ]

$routingState =

[line 70]



Tags:

access:  protected

Type:   RoutingState


[ Top ]



Class Methods


constructor __construct [line 80]

ClientRouting __construct( )

Constructor



Tags:

access:  public


Overridden in child classes as:

ClientDemoRouting::__construct()
Constructor

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method buildRequest [line 152]

void buildRequest( )



Tags:

access:  public
see:  ServerCaller::buildRequest()


[ Top ]

method createSession [line 97]

void createSession( MapInfo $mapInfo, InitialMapState $initialMapState)



Tags:

access:  public
see:  Sessionable::createSession()


[ Top ]

method drawRouting [line 188]

string drawRouting( )

Draws routing specific template



Tags:

access:  protected


Overridden in child classes as:

ClientDemoRouting::drawRouting()

[ Top ]

method handleHttpGetRequest [line 147]

void handleHttpGetRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpGetRequest()


[ Top ]

method handleHttpPostRequest [line 111]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleResult [line 182]

void handleResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::handleResult()


[ Top ]

method initializeResult [line 172]

void initializeResult( mixed $result)



Tags:

access:  public
see:  ServerCaller::initializeResult()


[ Top ]

method loadSession [line 90]

void loadSession( mixed $sessionObject)



Tags:

access:  public
see:  Sessionable::loadSession()


[ Top ]

method renderForm [line 202]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]

method saveSession [line 104]

void saveSession( )



Tags:

access:  public
see:  Sessionable::saveSession()


[ Top ]


Documentation generated on Mon, 13 Feb 2006 11:43:41 +0100 by phpDocumentor 1.3.0RC3