Class: ClientStatsReports

Source Location: /plugins/statsReports/client/ClientStatsReports.php

Class Overview

PluginBase
   |
   --ClientPlugin
      |
      --ClientStatsReports

Client plugin

Variables

Methods

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::getFolderId(): get folder id if set in plugin config
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 401]
Client plugin

[ Top ]

Class Variables

$actionName =

[line 436]

Tags:

access:

protected

Type:

mixed

[ Top ]

$column =

[line 419]

Tags:

access:

protected

Type:

mixed

[ Top ]

$data =

[line 414]

Tags:

access:

protected

Type:

mixed

[ Top ]

$datas =

[line 439]

Tags:

access:

protected

Type:

mixed

[ Top ]

$dbs = array()

[line 445]

Tags:

access:

protected

Type:

mixed

[ Top ]

$dimensions = array('time', 'project',
                                  'size', 'theme',
                                  'layer', 'scale',
                                  'user', 'pdfFormat',
                                  'pdfRes', 'value')

[line 407]

Tags:

access:

protected

Type:

mixed

[ Top ]

$display =

[line 417]

Tags:

access:

protected

Type:

mixed

[ Top ]

$getCsv =

[line 456]

Boolean, display export csv link or not

Tags:

access:

protected

Type:

mixed

[ Top ]

$layer =

[line 427]

Tags:

access:

protected

Type:

mixed

[ Top ]

$line =

[line 420]

Tags:

access:

protected

Type:

mixed

[ Top ]

$lines = array()

[line 451]

Tags:

access:

protected

Type:

mixed

[ Top ]

$pdfFormat =

[line 430]

Tags:

access:

protected

Type:

mixed

[ Top ]

$pdfRes =

[line 431]

Tags:

access:

protected

Type:

mixed

[ Top ]

$periodtype =

[line 416]

Tags:

access:

protected

Type:

mixed

[ Top ]

$project =

[line 424]

Tags:

access:

protected

Type:

mixed

[ Top ]

$report =

[line 415]

Tags:

access:

protected

Type:

mixed

[ Top ]

$reports = array()

[line 448]

Tags:

access:

protected

Type:

mixed

[ Top ]

$scale =

[line 428]

Tags:

access:

protected

Type:

mixed

[ Top ]

$size =

[line 425]

Tags:

access:

protected

Type:

mixed

[ Top ]

$statsReportsState =

[line 404]

Tags:

access:

protected

Type:

mixed

[ Top ]

$tempDb =

[line 442]

Tags:

access:

protected

Type:

mixed

[ Top ]

$theme =

[line 426]

Tags:

access:

protected

Type:

mixed

[ Top ]

$time =

[line 422]

Tags:

access:

protected

Type:

mixed

[ Top ]

$user =

[line 429]

Tags:

access:

protected

Type:

mixed

[ Top ]

$value =

[line 433]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

method ajaxGetPluginResponse [line 594]

void ajaxGetPluginResponse(
AjaxPluginResponse
$ajaxPluginResponse)

Tags:

access:	public
see:	Ajaxable::ajaxGetPluginResponse()

[ Top ]

method ajaxHandleAction [line 634]

void ajaxHandleAction(
mixed
$actionName, PluginEnabler
$pluginEnabler)

Tags:

access:	public
see:	Ajaxable::ajaxHandleAction()

[ Top ]

method buildRequest [line 658]

void buildRequest(
)

Tags:

access:	public
see:	ServerCaller::buildRequest()

[ Top ]

method convertDimensionFields [line 544]

void convertDimensionFields(
mixed
$request, mixed
$dimensions)

Tags:

access:

protected

[ Top ]

method convertFormFields [line 534]

void convertFormFields(
mixed
$request, mixed
$fields)

Tags:

access:

protected

[ Top ]

method createSession [line 512]

void createSession(
MapInfo
$mapInfo, InitialMapState
$initialMapState)

Tags:

access:	public
see:	Sessionable::createSession()

[ Top ]

method drawCsvLink [line 1622]

string drawCsvLink(
)

handle the templates to display a link to export the result to csv

Tags:

return:	smarty template
access:	protected

[ Top ]

method drawDisplayForm [line 850]

void drawDisplayForm(
)

Tags:

access:

protected

[ Top ]

method drawLegend [line 1563]

string drawLegend(
)

Draws legend (images generated by server)

Tags:

return:	generated HTML
access:	protected

[ Top ]

method drawOptionsForm [line 881]

void drawOptionsForm(
)

Tags:

access:

protected

[ Top ]

method drawPeriodTypeForm [line 818]

string drawPeriodTypeForm(
)

generate PeriodType option list template

Tags:

return:	smarty template
access:	protected

[ Top ]

method drawReportForm [line 787]

string drawReportForm(
)

generate report option list template

Tags:

return:	smarty template
access:	protected

[ Top ]

method drawResult [line 1101]

void drawResult(
)

Tags:

access:

protected

[ Top ]

method drawStatsReportsForm [line 709]

void drawStatsReportsForm(
)

Tags:

access:

protected

[ Top ]

method explodeList [line 687]

void explodeList(
mixed
$list)

Tags:

access:

public

[ Top ]

method getCurrentDb [line 1593]

void getCurrentDb(
)

Tags:

access:

public

[ Top ]

method getCurrentPeriodType [line 1607]

void getCurrentPeriodType(
)

Tags:

access:

public

[ Top ]

method getCurrentPrefix [line 1597]

void getCurrentPrefix(
)

Tags:

access:

public

[ Top ]

method getCurrentReport [line 1601]

void getCurrentReport(
)

Tags:

access:

public

[ Top ]

method getCurrentTableName [line 1611]

void getCurrentTableName(
)

Tags:

access:

public

[ Top ]

method getDataOptions [line 700]

void getDataOptions(
)

Tags:

access:

protected

[ Top ]

method getDb [line 676]

void getDb(
mixed
$dsn)

Tags:

access:

protected

[ Top ]

method getDbField [line 934]

void getDbField(
mixed
$dimension)

Tags:

access:

protected

[ Top ]

method getDimensionOptions [line 865]

void getDimensionOptions(
)

Tags:

access:

protected

[ Top ]

method getDisplayCount [line 858]

void getDisplayCount(
)

Tags:

access:

protected

[ Top ]

method getDisplayOptions [line 832]

void getDisplayOptions(
)

Tags:

access:

protected

[ Top ]

method getField [line 930]

void getField(
mixed
$id)

Tags:

access:

public

[ Top ]

method getFilename [line 1631]

string getFilename(
)

Builds exported file name.

Tags:

access:

protected

[ Top ]

method getGraph [line 1280]

void getGraph(
mixed
$title, mixed
$type, mixed
$xUnit, mixed
$data, mixed
$md5)

Tags:

access:

protected

[ Top ]

method getGridResults [line 1043]

void getGridResults(
)

Tags:

access:

protected

[ Top ]

method getMap [line 1393]

void getMap(
)

Tags:

access:

protected

[ Top ]

method getPeriodTypeCount [line 826]

void getPeriodTypeCount(
)

Tags:

access:

protected

[ Top ]

method getPeriodTypeOptions [line 799]

array getPeriodTypeOptions(
)

generate PeriodType option list based on the main report object

Tags:

return:	report period => period (max)
access:	protected

[ Top ]

method getReportOptions [line 772]

array getReportOptions(
)

generate report option list based on the main report object

Tags:

return:	associative array report name => report label
access:	protected

[ Top ]

method getReports [line 721]

array getReports(
)

get basic info about reports

Tags:

access:

protected

[ Top ]

method getSelectedOptions [line 941]

void getSelectedOptions(
mixed
$dimension)

Tags:

access:

protected

[ Top ]

method getSimpleResults [line 948]

void getSimpleResults(
)

Tags:

access:

protected

[ Top ]

method getTableName [line 1388]

void getTableName(
)

Tags:

access:

protected

[ Top ]

method getTabularData [line 1250]

object stdClass getTabularData(
array
$lineOptions, array
$columnOptions)

generate a complex object containing array of values with column and line headers

Tags:

access:

protected

Parameters:

array	$lineOptions	line headers
array	$columnOptions	column headers

[ Top ]

method handleHttpGetRequest [line 589]

void handleHttpGetRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpGetRequest()

[ Top ]

method handleHttpPostRequest [line 558]

void handleHttpPostRequest(
mixed
$request)

Tags:

access:	public
see:	GuiProvider::handleHttpPostRequest()

[ Top ]

method handleResult [line 674]

void handleResult(
mixed
$outlineResult)

Tags:

access:	public
see:	ServerCaller::handleResult()

[ Top ]

method initialize [line 461]

void initialize(
)

Initialization

Tags:

access:

public

Overrides PluginBase::initialize() (Plugin initialization (can be extended in custom plugins))

[ Top ]

method initializeResult [line 669]

void initializeResult(
mixed
$outlineResult)

Tags:

access:	public
see:	ServerCaller::initializeResult()

[ Top ]

method loadSession [line 502]

void loadSession(
mixed
$sessionObject)

Tags:

access:	public
see:	Sessionable::loadSession()

[ Top ]

method renderForm [line 529]

void renderForm(
Smarty
$template)

Tags:

access:	public
see:	GuiProvider::renderForm()

[ Top ]

method saveSession [line 521]

void saveSession(
)

Tags:

access:	public
see:	Sessionable::saveSession()

[ Top ]

Documentation generated on Thu, 23 May 2013 13:31:04 +0200 by phpDocumentor 1.3.0RC3

Class: ClientStatsReports

Class Overview

Variables

Methods

Inherited Constants

Class: ClientPlugin

Inherited Variables

Class: ClientPlugin

Class: PluginBase

Inherited Methods

Class: ClientPlugin

Class: PluginBase

Class Details

Class Variables

$actionName =

Tags:

$column =

Tags:

$data =

Tags:

$datas =

Tags:

$dbs = array()

Tags:

$dimensions = array('time', 'project', 'size', 'theme', 'layer', 'scale', 'user', 'pdfFormat', 'pdfRes', 'value')

Tags:

$display =

Tags:

$getCsv =

Tags:

$layer =

Tags:

$line =

Tags:

$lines = array()

Tags:

$pdfFormat =

Tags:

$pdfRes =

Tags:

$periodtype =

Tags:

$project =

Tags:

$report =

Tags:

$reports = array()

Tags:

$scale =

Tags:

$size =

Tags:

$statsReportsState =

Tags:

$tempDb =

Tags:

$theme =

Tags:

$time =

Tags:

$user =

Tags:

$value =

Tags:

Class Methods

method ajaxGetPluginResponse [line 594]

Tags:

method ajaxHandleAction [line 634]

Tags:

method buildRequest [line 658]

Tags:

method convertDimensionFields [line 544]

Tags:

method convertFormFields [line 534]

Tags:

method createSession [line 512]

Tags:

method drawCsvLink [line 1622]

Tags:

method drawDisplayForm [line 850]

$dimensions = array('time', 'project',
'size', 'theme',
'layer', 'scale',
'user', 'pdfFormat',
'pdfRes', 'value')