Class: ClientProjectplugin

Source Location: /projects/test_project/plugins/projectplugin/client/ClientProjectplugin.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientProjectplugin

Variables

Constants

PROJECTPLUGIN_INPUT

Methods

Inherited Constants

Class: ClientPlugin

ClientPlugin::ENABLE_LEVEL_FULL
ClientPlugin::ENABLE_LEVEL_LOAD
ClientPlugin::ENABLE_LEVEL_PROCESS
ClientPlugin::ENABLE_LEVEL_SERVERCALL

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config
ClientPlugin::$enabledLevel

Class: PluginBase

PluginBase::$basePath
PluginBase::$name
PluginBase::$overriddenRequest

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::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 10]

[ Top ]

Class Variables

$count =

[line 18]

Tags:

access:

private

Type:

mixed

[ Top ]

$initMessage =

[line 19]

Tags:

access:

private

Type:

mixed

[ Top ]

$log =

[line 16]

Tags:

access:

private

Type:	mixed
Overrides:	Array

[ Top ]

$message =

[line 17]

Tags:

access:

private

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 24]

ClientProjectplugin __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method buildRequest [line 52]

void buildRequest(
)

Tags:

access:

public

[ Top ]

method createSession [line 39]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Tags:

access:

public

[ Top ]

method handleHttpGetRequest [line 50]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:

public

[ Top ]

method handleHttpPostRequest [line 46]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:

public

[ Top ]

method handleInit [line 79]

void handleInit(
mixed
$init)

Tags:

access:

public

[ Top ]

method handleResult [line 68]

void handleResult(
mixed
$result)

Tags:

access:

public

[ Top ]

method initialize [line 30]

void initialize(
)

Tags:

access:

public

Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins))

[ Top ]

method initializeResult [line 62]

void initializeResult(
mixed
$result)

Tags:

access:

public

[ Top ]

method loadSession [line 35]

void loadSession(
mixed
$sessionObject)

Tags:

access:

public

[ Top ]

method renderForm [line 70]

void renderForm(
Smarty
$template)

Tags:

access:

public

[ Top ]

method saveSession [line 42]

void saveSession(
)

Tags:

access:

public

[ Top ]

Class Constants

PROJECTPLUGIN_INPUT = 'projectplugin_input'

[line 14]

[ Top ]

Documentation generated on Fri, 21 Sep 2007 13:30:41 +0200 by phpDocumentor 1.3.0RC3