Class: ExportPlugin

Source Location: /client/ExportPlugin.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ExportPlugin

Export plugin

Author(s):

Methods

Child classes:

ClientExportCsv: CSV Export

ClientExportHtml: HTML export

ClientExportPdf: Overall class for PDF generation management.

Inherited Variables

Class: ClientPlugin

ClientPlugin::$cartoclient
ClientPlugin::$config
ClientPlugin::$log

Class: PluginBase

PluginBase::$basePath
PluginBase::$name

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::replacePlugin(): Returns name of parent plugin in case of plugin extension
PluginBase::setBasePath()
PluginBase::setExtendedName()
PluginBase::setName()

Class Details

[line 411]
Export plugin

Tags:

abstract:

[ Top ]

Class Methods

method getExport [line 496]

ExportOutput getExport(
)

Renders export

Tags:

return:	export result
abstract:

Overridden in child classes as:

ClientExportCsv::getExport(): Computes CSV export

ClientExportHtml::getExport(): Computes HTML export

ClientExportPdf::getExport()

[ Top ]

method getExportResult [line 462]

MapResult getExportResult(
ExportConfiguration
$configuration)

Retrieves MapResult

Gets last request
Calls plugins to adjust request
Calls server's getMap

Tags:

return:	server result
access:	public

Parameters:

ExportConfiguration

$configuration

configuration

[ Top ]

method getExportScriptPath [line 421]

string getExportScriptPath(
)

Returns export script path. This assumes the script is called export.php in the htdocs directory of the plugin. Clients should override this if this is not the case.

Tags:

return:	The export script path
access:	public

Overridden in child classes as:

ClientExportCsv::getExportScriptPath(): Returns relative Web path to external export script

[ Top ]

method getLastMapRequest [line 431]

MapRequest getLastMapRequest(
)

Returns session-saved last MapRequest.

Tags:

access:

public

[ Top ]

method getLastMapResult [line 444]

MapResult getLastMapResult(
)

Returns session-saved last MapResult.

Tags:

access:

public

[ Top ]

Documentation generated on Wed, 6 Apr 2005 12:06:39 +0200 by phpDocumentor 1.3.0RC3