Class: ClientExportLinkIt

Source Location: /plugins/exportLinkIt/client/ClientExportLinkIt.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ExportPlugin
         |
         --ClientExportLinkIt

Variables

Constants

TOOL_LINKIT

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: ExportPlugin

ExportPlugin::getExport(): Renders export
ExportPlugin::getExportResult(): Retrieves MapResult
ExportPlugin::getExportUrl(): Returns base export plugin URL.
ExportPlugin::getLastMapRequest(): Returns session-saved last MapRequest.
ExportPlugin::getLastMapResult(): Returns session-saved last MapResult.
ExportPlugin::output(): Outputs exported content.

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

[ Top ]

Class Variables

$isUrlCompressed =

[line 41]

Tags:

access:

protected

Type:

boolean

[ Top ]

$isUrlTooLong = false

[line 51]

Tags:

access:

protected

Type:

boolean

[ Top ]

$lastMapRequest =

[line 66]

Tags:

access:

protected

Type:

MapRequest

[ Top ]

$lastMapResult =

[line 71]

Tags:

access:

protected

Type:

MapResult

[ Top ]

$log =

[line 36]

Tags:

access:

private

Type:	Logger
Overrides:	Array

[ Top ]

$params = array()

[line 56]

Tags:

access:

protected

Type:

array

[ Top ]

$paramSwitch =

[line 61]

Tags:

access:

protected

Type:

string

[ Top ]

$queryString = ''

[line 46]

Tags:

access:

protected

Type:

string

[ Top ]

$session =

[line 76]

Tags:

access:

protected

Type:

ClientSession

[ Top ]

Class Methods

constructor __construct [line 86]

ClientExportLinkIt __construct(
)

Constructor

Tags:

access:

public

Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method addCustomizedParams [line 396]

void addCustomizedParams(
)

Use this method to add your own parameters from customized plugins.

Tags:

access:

protected

[ Top ]

method addImageParams [line 287]

void addImageParams(
)

Sets GET parameters for image data.

Tags:

access:

protected

[ Top ]

method addLayersParams [line 252]

void addLayersParams(
)

Sets GET parameters for layer data.

Tags:

access:

protected

[ Top ]

method addLocationParams [line 279]

void addLocationParams(
)

Sets GET parameters for location data.

Tags:

access:

protected

[ Top ]

method addOutlineParams [line 311]

void addOutlineParams(
)

Sets GET parameters for outline data.

Tags:

access:

protected

[ Top ]

method addQueryParams [line 359]

void addQueryParams(
)

Sets GET parameters for query data.

Tags:

access:

protected

[ Top ]

method drawLinkBox [line 189]

string drawLinkBox(
)

Returns "link it" box HTML

Tags:

access:

protected

[ Top ]

method drawLinkBoxContainer [line 179]

string drawLinkBoxContainer(
)

Returns linkIt box container HTML

Tags:

access:

protected

[ Top ]

method filterGetRequest [line 104]

void filterGetRequest(
FilterRequestModifier
$request)

Tags:

access:	public
see:	FilterProvider::filterGetRequest()

[ Top ]

method filterPostRequest [line 99]

void filterPostRequest(
FilterRequestModifier
$request)

Tags:

access:	public
see:	FilterProvider::filterPostRequest()

[ Top ]

method getExport [line 427]

void getExport(
)

Tags:

access:	protected
see:	ExportPlugin::getExport()

Overrides ExportPlugin::getExport() (Renders export)

[ Top ]

method getLinkUrl [line 201]

string getLinkUrl(
[boolean
$useXhtml = true])

Builds URL that describes current map context.

Tags:

access:

protected

Parameters:

boolean

$useXhtml

(default true) tells if URL special chars must be escaped

[ Top ]

method getTools [line 418]

void getTools(
)

Tags:

access:	public
see:	ToolProvider::getTools()

[ Top ]

method handleApplicationTool [line 413]

void handleApplicationTool(
ToolDescription
$tool)

Tags:

access:	public
see:	ToolProvider::handleApplicationTool()

[ Top ]

method handleHttpGetRequest [line 165]

void handleHttpGetRequest(
array
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

Parameters:

array

$request

HTTP request

[ Top ]

method handleHttpPostRequest [line 159]

void handleHttpPostRequest(
array
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

Parameters:

array

$request

HTTP request

[ Top ]

method handleKeymapTool [line 407]

void handleKeymapTool(
ToolDescription
$tool, Shape
$keymapShape)

Tags:

access:	public
see:	ToolProvider::handleKeymapTool()

[ Top ]

method handleMainmapTool [line 401]

void handleMainmapTool(
ToolDescription
$tool, Shape
$mainmapShape)

Tags:

access:	public
see:	ToolProvider::handleMainmapTool()

[ Top ]

method Initialize [line 92]

void Initialize(
)

Tags:

access:

public

[ Top ]

method output [line 432]

void output(
)

Tags:

access:	public
see:	ExportPlugin::output()

Overrides ExportPlugin::output() (Outputs exported content.)

[ Top ]

method renderForm [line 171]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

Parameters:

Smarty

$template

[ Top ]

method setContextQueryString [line 223]

void setContextQueryString(
)

Sets query string var with map context info.

Tags:

access:

protected

[ Top ]

Class Constants

TOOL_LINKIT = 'linkit'

[line 81]

Tool constant

[ Top ]

Documentation generated on Thu, 09 Feb 2012 13:30:39 +0100 by phpDocumentor 1.3.0RC3