BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
BsDiagram Class Reference
Inheritance diagram for BsDiagram:

Public Member Functions

 __construct ()
 
 getSql ()
 
 isList ()
 
 isListable ()
 
 setStartTime ($sStartTime)
 
 getStartTime ()
 
 setEndTime ($sEndTime)
 
 getEndTime ()
 
 setActualGrain ($sActualGrain)
 
 getActualGrain ()
 
 setMode ($sMode)
 
 setMessage ($sMessage)
 
 getMode ()
 
 getMessage ()
 
 setFilters ($aFilters)
 
 getFilters ()
 
 addFilter ($oFilter)
 
 getFilter ($sFilterKey)
 
 setData ($aData)
 
 getData ()
 
 setLabelsX ($aLabelsX)
 
 getLabelsX ()
 
 setFormatX ($sFormatX)
 
 getFormatX ()
 
 setTitle ($sTitle)
 
 getTitle ()
 
 setTitleX ($sTitleX)
 
 getTitleX ()
 
 setTitleY ($sTitleY)
 
 getTitleY ()
 
 setDescription ($sDescription)
 
 getDescription ()
 
 addFilterText ($sFilterText)
 
 getFilterText ()
 
 getDataSource ()
 
 setModLabel ($sModLabel)
 
 getModLabel ()
 
 getListLabel ()
 
 getDiagramKey ()
 

Public Attributes

const GRAIN_DAY = 'd'
 
const GRAIN_WEEK = 'W'
 
const GRAIN_MONTH = 'm'
 
const GRAIN_YEAR = 'y'
 
const DATASOURCE_DATABASE = 1
 
const DATASOURCE_LOGFILE = 2
 
const MODE_ABSOLUTE = "absolute"
 
const MODE_AGGREGATED = "aggregated"
 
const MODE_LIST = "list"
 

Protected Attributes

 $sStartTime
 
 $sEndTime
 
 $sActualGrain
 
 $iDataSource
 
 $sMode
 
 $sMessage
 
 $aFilters = array()
 
 $aData = array()
 
 $aLabelsX = array()
 
 $sModLabel
 
 $sListLabel
 
 $sSqlWhatForDiagram
 
 $sSqlOptionsForDiagram
 
 $sSqlWhatForList
 
 $sSqlOptionsForList
 
 $sSqlWhatFromWhere
 
 $bListable
 
 $sFormatX
 
 $sTitle
 
 $sTitleX
 
 $sTitleY
 
 $sDescription
 
 $sFilterText = ''
 

Constructor & Destructor Documentation

BsDiagram::__construct ( )

Constructor of BsDiagram class

Member Function Documentation

BsDiagram::addFilter (   $oFilter)

Adds a filter to list of available filters

Parameters
BsStatisticsFilter$oFilter
BsDiagram::addFilterText (   $sFilterText)

Adds a description of active filter.

Parameters
string$sFilterText
BsDiagram::getActualGrain ( )

Get grain to use

Returns
string BsDiagram::GRAIN_
BsDiagram::getData ( )

Gets list of data points

Returns
array List of integers
BsDiagram::getDataSource ( )

Gets source of data

Returns
int BsDiagram::DATASOURCE_
BsDiagram::getDescription ( )

Gets description of diagram

Returns
string
BsDiagram::getDiagramKey ( )

Gets the diagram key

Returns
string
BsDiagram::getEndTime ( )

Get upper boundary of date interval

Returns
string Date string
BsDiagram::getFilter (   $sFilterKey)

Returns an active filter

Parameters
string$sFilterKeyParamKey of filter
Returns
BsStatisticsFilter Instance of filter.
BsDiagram::getFilters ( )

Get list of available filters for this diagram

Returns
array List of BsStatisticsFilter
BsDiagram::getFilterText ( )

Gets description of active filters.

Returns
string
BsDiagram::getFormatX ( )

Gets format of point labels

Returns
string Format as defined by jpGraph
BsDiagram::getLabelsX ( )

Gets list of x axis labels

Returns
array List of strings
BsDiagram::getListLabel ( )

Gets headings for column headers

Returns
array
BsDiagram::getMessage ( )

Get mode of data presentation

Returns
string BsDiagram::MODE_
BsDiagram::getMode ( )

Get mode of data presentation

Returns
string BsDiagram::MODE_
BsDiagram::getModLabel ( )

Gets format labels for x shall be generated from

Returns
string time format item, e.g. "M" for month (Jan, Feb...)
BsDiagram::getSql ( )

Get current SQL statement for data retrieval

Returns
string SQL statement
BsDiagram::getStartTime ( )

Get lower boundary of date interval

Returns
string Date string
BsDiagram::getTitle ( )

Gets overall title of the diagram

Parameters
string
BsDiagram::getTitleX ( )

Gets title for x axis

Parameters
string
BsDiagram::getTitleY ( )

Gets title for y axis

Returns
string
BsDiagram::isList ( )

Is this diagram a list

Returns
bool
BsDiagram::isListable ( )

Can this diagram be presented in list mode.

Returns
bool
BsDiagram::setActualGrain (   $sActualGrain)

Set grain to use

Parameters
string$sActualGrainBsDiagram::GRAIN_
BsDiagram::setData (   $aData)

Sets list of data points

Parameters
array$aDataList of integers
BsDiagram::setDescription (   $sDescription)

Sets description of diagram

Parameters
string$sDescription
BsDiagram::setEndTime (   $sEndTime)

Set u boundary of date interval

Parameters
string$sEndTimeDate string
BsDiagram::setFilters (   $aFilters)

Set list of available filters for this diagram

Parameters
array$aFiltersList of BsStatisticsFilter
BsDiagram::setFormatX (   $sFormatX)

Sets format of point labels

Parameters
string$sFormatXFormat as defined by jpGraph
BsDiagram::setLabelsX (   $aLabelsX)

Sets list of x axis labels

Parameters
array$aLabelsXList of strings
BsDiagram::setMessage (   $sMessage)

Set mode of data presentation

Parameters
string$sModeBsDiagram::MODE_
BsDiagram::setMode (   $sMode)

Set mode of data presentation

Parameters
string$sModeBsDiagram::MODE_
BsDiagram::setModLabel (   $sModLabel)

Sets format labels for x shall be generated from

Parameters
string$sModLabeltime format item, e.g. "M" for month (Jan, Feb...)
BsDiagram::setStartTime (   $sStartTime)

Set ower boundary of date interval

Parameters
string$sStartTimeDate string
BsDiagram::setTitle (   $sTitle)

Sets overall title of the diagram

Parameters
string$sTitle
BsDiagram::setTitleX (   $sTitleX)

Sets title for x axis

Parameters
string$sTitleX
BsDiagram::setTitleY (   $sTitleY)

Sets title for y axis

Parameters
string$sTitleY

Member Data Documentation

const BsDiagram::DATASOURCE_DATABASE = 1

Data shall be retrieved from database

const BsDiagram::DATASOURCE_LOGFILE = 2

Data shall be retrieved fromlogfile

const BsDiagram::GRAIN_DAY = 'd'

Diagram time resoution: days

const BsDiagram::GRAIN_MONTH = 'm'

Diagram time resoution: months

const BsDiagram::GRAIN_WEEK = 'W'

Diagram time resoution: (calendar) weeks

const BsDiagram::GRAIN_YEAR = 'y'

Diagram time resoution: years

const BsDiagram::MODE_ABSOLUTE = "absolute"

Data shall be presented as is

const BsDiagram::MODE_AGGREGATED = "aggregated"

Data shall be aggregated (added up)

const BsDiagram::MODE_LIST = "list"

Data shall be presented as a list


The documentation for this class was generated from the following file: