Client

# Class: ExportPlugin Source Location: /client/ExportPlugin.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ExportPlugin
Export plugin #### Author(s): | ### Methods getExport getExportResult getExportUrl getLastMapRequest getLastMapResult output
### Child classes: ClientExportHtml HTML export ClientExportCsv CSV Export ClientExportDxf ClientExportPdf Overall class for PDF generation management. ClientExportRtf Overall class for generating RTF | ### 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 ClientPlugin::$log #### 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 468] Export plugin #### Tags:
abstract: |
[ Top ] ### Class Methods ### method getExport [line 550]
`ExportOutput getExport( )`
Renders export #### Tags:
return: | export result
access: | protected
abstract: |
Overridden in child classes as: ClientExportHtml::getExport() Computes HTML export ClientExportCsv::getExport() Computes CSV export ClientExportDxf::getExport() ClientExportPdf::getExport() ClientExportRtf::getExport() [ Top ] ### method getExportResult [line 511]
`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 getExportUrl [line 539]
`string getExportUrl( )`
Returns base export plugin URL. #### Tags:
access: | protected
[ Top ] ### method getLastMapRequest [line 475]
`MapRequest getLastMapRequest( )`
Returns session-saved last MapRequest. #### Tags:
access: | public
[ Top ] ### method getLastMapResult [line 491]
`MapResult getLastMapResult( )`
Returns session-saved last MapResult. #### Tags:
access: | public
[ Top ] ### method output [line 556]
`string output( )`
Outputs exported content. #### Tags:
access: | public
abstract: |
Overridden in child classes as: ClientExportHtml::output() ClientExportCsv::output() ClientExportDxf::output() ClientExportPdf::output() ClientExportRtf::output() [ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:47 +0200 by phpDocumentor 1.3.0RC3