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

Class: ClientExportCsv

Source Location: /plugins/exportCsv/client/ClientExportCsv.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ExportPlugin
         |
         --ClientExportCsv

CSV Export


Variables

Methods


Inherited Variables

Inherited Methods

Class: ExportPlugin

ExportPlugin::getExport()
Renders export
ExportPlugin::getExportResult()
Retrieves MapResult
ExportPlugin::getExportScriptPath()
Returns export script path. This assumes the script is called export.php in the htdocs directory of the plugin. Clients should override this if this is not the case.
ExportPlugin::getLastMapRequest()
Returns session-saved last MapRequest.
ExportPlugin::getLastMapResult()
Returns session-saved last MapResult.

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::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 67]

ClientExportCsv __construct( )

Constructor



Tags:

access:  public


Overrides ClientPlugin::__construct() (Constructor)

[ Top ]

method exportLine [line 143]

string exportLine( array $array, string $sep, string $tD, boolean 3)

Returns an exported CSV single line



Tags:

access:  private


Parameters:

boolean   3   true if UTF8 decoding is required
array   $array   values
string   $sep   separator
string   $tD   text delimiter

[ Top ]

method generateFileName [line 78]

string generateFileName( )

Returns CSV file name

Format is set in configuration file, key fileName.




Tags:

access:  private


[ Top ]

method getConfiguration [line 125]

ExportConfiguration getConfiguration( )

Builds export configuration.



Tags:

access:  public


[ Top ]

method getExport [line 164]

ExportOutput getExport( )

Computes CSV export



Tags:

access:  public
see:  ExportPlugin::getExportResult


Overrides ExportPlugin::getExport() (Renders export)

[ Top ]

method getExportScriptPath [line 55]

string getExportScriptPath( )

Returns relative Web path to external export script



Tags:

access:  public
see:  ExportPlugin::getExportScriptPath()


Overrides ExportPlugin::getExportScriptPath() (Returns export script path. This assumes the script is called export.php in the htdocs directory of the plugin. Clients should override this if this is not the case.)

[ Top ]

method handleHttpGetRequest [line 106]

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 98]

void handleHttpPostRequest( mixed $request)



Tags:

access:  public
see:  GuiProvider::handleHttpPostRequest()


[ Top ]

method renderForm [line 118]

void renderForm( Smarty $template)



Tags:

access:  public
see:  GuiProvider::renderForm()


[ Top ]


Documentation generated on Wed, 6 Apr 2005 12:06:29 +0200 by phpDocumentor 1.3.0RC3