Plugins

# Class: ClientExportHtml Source Location: /plugins/exportHtml/client/ClientExportHtml.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ExportPlugin
             |
             --ClientExportHtml
HTML export | ### Methods __construct getBaseUrl getConfiguration getExport handleHttpGetRequest handleHttpPostRequest output renderForm
### 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: 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::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 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 Fri, 21 Sep 2007 13:30:35 +0200 by phpDocumentor 1.3.0RC3