\GraphRenderer
- \GraphRenderer_AbstractTicker

abstract class (none) \ GraphRenderer_AbstractTicker

All known direct subclasses:: GraphRenderer_BalancesGraph,GraphRenderer_ExternalHistorical,GraphRenderer_StatisticsQueue,GraphRenderer_StatisticsSystemLoad,GraphRenderer_SummaryGraph,GraphRenderer_Ticker

This line graph renderer abstracts away common functionality for graphs that - get data from the database - from a number of sources, which have to be collated together - returns data based on dates - returns 1..2 values

Method Summary

Name	Description
__construct()
getData($days)
getTickerArgs()
getTickerColumns()
getTickerData($row)
getTickerSources($days, $extra_days)	The sources must return 'created_at' column as well, for last_updated
isDaily()

Inherited Method Summary

Name	Description
canHaveTechnicals()	Can this graph have technicals? If this returns `true`, then the resulting data will always be sorted. By default, returns `true`. (from GraphRenderer)
convertGraphToProportional($original)	Relabel all columns to have ' %' prefix, and reformat all data to be proportional based on the sum of each row. Uses the output of #getData(). (from GraphRenderer)
getChartType()	What type of chart is this rendered as? By default, returns `linechart`. (from GraphRenderer)
getClasses()	(from GraphRenderer)
getCustomSubheading()	Calculate the custom subheading value for this graph, or `false` if this graph does not have a custom subheading defined (and subheadings calculated through #hasSubheading() will use default sum/array logic). By default, returns `false`. (from GraphRenderer)
getLabel()	Get the label that should be associated with the #getURL(), or `false` if there shouldn't be any. Should be wrapped in ct(). (from GraphRenderer)
getTitle()	Get the title of this graph (from GraphRenderer)
getTitleArgs()	Get any localisation (i18n) string arguments for the title given in #getTitle(). By default, returns an empty array. (from GraphRenderer)
getURL()	Get the URL that the title of this graph should link to, or `false` if it should not link anywhere (from GraphRenderer)
getUser()	(from GraphRenderer)
hasSubheading()	Does this graph have a subheading? By default, returns `true`. (from GraphRenderer)
requiresAdmin()	Does rendering this graph require an admin user? By default, returns `false`. (from GraphRenderer)
requiresUser()	Does rendering this graph require a user? By default, returns `false`. (from GraphRenderer)
setUser($user_id)	(from GraphRenderer)
usesDays()	Does this function require a days parameter? If `true`, then the returned data will be stripped based on the keys returned in the data - assumes that the data uses dates as keys. By default, returns `true`. (from GraphRenderer)
usesSummaries()	Does this graph use summaries which may be out of date for a user? By default, returns `false`. (from GraphRenderer)

public function __construct()

Overrides:

__construct()

public function getData($days)

Overrides:

getData($days)

Returns:

an array of (columns => [column], data => [(date, value)], last_updated => (date or false))

abstract function getTickerArgs()

Returns:

an array of arguments passed to each #getTickerSources()

abstract function getTickerColumns()

Returns:

an array of columns e.g. (type, title, args)

abstract function getTickerData($row)

Returns:

an array of 1..2 values of the values for the particular row, maybe formatted with #graph_number_format.

abstract function getTickerSources($days, $extra_days)

The sources must return 'created_at' column as well, for last_updated

Returns:

an array of queries e.g. (query, key = created_at/data_date)

public function isDaily()

Returns:

true if data should be limited to days, or false if it can have any resolution. defaults to true