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

Class: ClientExportHtml

Source Location: /plugins/exportHtml/client/ClientExportHtml.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ExportPlugin
         |
         --ClientExportHtml

HTML export


Methods


Inherited Variables

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::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 33]
HTML export



[ Top ]


Class Methods


constructor __construct [line 38]

ClientExportHtml __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method getBaseUrl [line 49]

string getBaseUrl( )

Returns path to Web base URL

Being in a plugin, the path to images is not the same.




Tags:

access:  public


[ Top ]

method getConfiguration [line 79]

ExportConfiguration getConfiguration( )

Builds export configuration.



Tags:

access:  public


[ Top ]

method getExport [line 96]

ExportOutput getExport( )

Computes HTML export

Looks for displayed layers in latest MapRequest.




Tags:

access:  protected
see:  ExportPlugin::getExportResult


Overrides ExportPlugin::getExport() (Renders export)

[ Top ]

method handleHttpGetRequest [line 63]

void handleHttpGetRequest( mixed $request)

Not used.



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method handleHttpPostRequest [line 57]

void handleHttpPostRequest( mixed $request)

Not used.



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method output [line 140]

void output( )



Tags:

access:  public
see:  ExportPlugin::output()


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

[ Top ]

method renderForm [line 69]

void renderForm( Smarty $template)

Draws "print" link or button used to launch HTML export.



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]


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