Plugins

# Class: ClientExportCsv Source Location: /plugins/exportCsv/client/ClientExportCsv.php
### Class Overview
    PluginBase
       |
       --ClientPlugin
          |
          --ExportPlugin
             |
             --ClientExportCsv
CSV Export | ### Variables $fileName $groupId $tableId | ### Methods __construct exportLine generateFileName getConfiguration getExport getUrl 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] CSV Export [ Top ] ### Class Variables #### $fileName = [line 48] #### Tags:
access: | public
Type: | string
[ Top ] #### $groupId = [line 38] #### Tags:
access: | public
Type: | string
[ Top ] #### $tableId = [line 43] #### Tags:
access: | public
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 53]
`ClientExportCsv __construct( )`
Constructor #### Tags:
access: | public
Overrides ClientPlugin::__construct() (Constructor) [ Top ] ### method exportLine [line 139]
`string exportLine( array $array, string $sep, string $tD, boolean 3)`
Returns an exported CSV single line #### Tags:
access: | protected
#### Parameters:
boolean | 3 | true if UTF8 decoding is required
array | $array | values
string | $sep | separator
string | $tD | text delimiter
[ Top ] ### method generateFileName [line 64]
`string generateFileName( )`
Returns CSV file name Format is set in configuration file, key fileName. #### Tags:
access: | protected
[ Top ] ### method getConfiguration [line 121]
`ExportConfiguration getConfiguration( )`
Builds export configuration. #### Tags:
access: | public
[ Top ] ### method getExport [line 160]
`ExportOutput getExport( )`
Computes CSV export #### Tags:
access: | protected
see: | ExportPlugin::getExportResult
Overrides ExportPlugin::getExport() (Renders export) [ Top ] ### method getUrl [line 108]
`string getUrl( )`
Public alias for ExportPlugin::getExportUrl(). #### Tags:
access: | public
[ Top ] ### method handleHttpGetRequest [line 95]
`void handleHttpGetRequest( array $request)`
Handles HTTP request received by script export.php #### Tags:
access: | public
see: | GuiProvider::handleHttpGetRequest()
#### Parameters:
array | $request | HTTP request
[ Top ] ### method handleHttpPostRequest [line 88]
`void handleHttpPostRequest( mixed $request)`
#### Tags:
access: | public
see: | GuiProvider::handleHttpPostRequest()
[ Top ] ### method output [line 216]
`void output( )`
#### Tags:
access: | public
see: | ExportPlugin::output()
Overrides ExportPlugin::output() (Outputs exported content.) [ Top ] ### method renderForm [line 115]
`void renderForm( Smarty $template)`
#### Tags:
access: | public
see: | GuiProvider::renderForm()
[ Top ] Documentation generated on Fri, 21 Sep 2007 13:30:35 +0200 by phpDocumentor 1.3.0RC3