Plugins

# Class: ClientExportDxf Source Location: /plugins/exportDxf/client/ClientExportDxf.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ExportPlugin
             |
             --ClientExportDxf
| ### Variables $log $outline $roundLevel | ### Methods __construct ajaxGetPluginResponse ajaxHandleAction getDxfPoint getExport getFilename getRoundLevel handleHttpGetRequest handleHttpPostRequest initialize output removeAccents renderForm renderFormPrepare
### 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::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 60] [ Top ] ### Class Variables #### $log = [line 66] #### Tags:
access: | private
Type: | Logger
Overrides: | Array
[ Top ] #### $outline = [line 71] #### Tags:
access: | protected
Type: | ClientOutline
[ Top ] #### $roundLevel = [line 76] #### Tags:
access: | protected
Type: | integer
[ Top ] ### Class Methods ### constructor __construct [line 81]
`ClientExportDxf __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method ajaxGetPluginResponse [line 135]
`void ajaxGetPluginResponse( AjaxPluginResponse $ajaxPluginResponse)`
#### Tags:
access: | public
see: | Ajaxable::ajaxGetPluginResponse()
[ Top ] ### method ajaxHandleAction [line 144]
`void ajaxHandleAction( mixed $actionName, PluginEnabler $pluginEnabler)`
#### Tags:
access: | public
see: | Ajaxable::ajaxHandleAction()
[ Top ] ### method getDxfPoint [line 166]
`Point getDxfPoint( Point $point)`
Returns a Point object with rounded coordinates. #### Tags:
access: | protected
[ Top ] ### method getExport [line 190]
`void getExport( )`
#### Tags:
access: | protected
see: | ExportPlugin::getExport
Overrides ExportPlugin::getExport() (Renders export) [ Top ] ### method getFilename [line 241]
`string getFilename( )`
Builds exported file name. #### Tags:
access: | protected
[ Top ] ### method getRoundLevel [line 155]
`integer getRoundLevel( )`
Returns the number of digits displayed after the comma in points coordinates. #### Tags:
access: | protected
[ Top ] ### method handleHttpGetRequest [line 106]
`void handleHttpGetRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
[ Top ] ### method handleHttpPostRequest [line 101]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method initialize [line 89]
`void initialize( )`
#### Tags:
access: | public
see: | PluginBase::initialize()
Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins)) [ Top ] ### method output [line 227]
`void output( )`
#### Tags:
access: | public
see: | ExportPlugin::output()
Overrides ExportPlugin::output() (Outputs exported content.) [ Top ] ### method removeAccents [line 178]
`string removeAccents( string $str)`
Replaces accentuated letters by non accentuated ones. #### Tags:
access: | protected
#### Parameters:
string | $str |
[ Top ] ### method renderForm [line 128]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] ### method renderFormPrepare [line 113]
`array renderFormPrepare( )`
This method factors the plugin output for both GuiProvider::renderForm() and Ajaxable::ajaxGetPluginResponse(). #### Tags:
return: | array of variables and html code to be assigned
access: | protected
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:35 +0200 by phpDocumentor 1.3.0RC3