- \GraphRenderer
- \GraphRenderer_AbstractCompositionGraph
abstract class (none) \ GraphRenderer_AbstractCompositionGraph
- All known direct subclasses:
- GraphRenderer_BtcEquivalentGraph,GraphRenderer_CompositionGraph
Method Summary
| Name | Description |
|---|---|
| __construct($currency) | |
| getCompositionArgs() | |
| getCompositionSources($days, $extra_days) | |
| getData($days) | |
| getHeadingTitle($key, $args) | e.g. #get_exchange_name |
| hasSubheading() |
Does this graph have a subheading? By default, returns true. |
| isDaily() | |
| requiresUser() |
Does rendering this graph require a user? By default, returns false. |
| usesSummaries() |
Does this graph use summaries which may be out of date for a user? By default, returns false. |
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) |
| requiresAdmin() |
Does rendering this graph require an admin 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)
|
public function __construct($currency)
- Overrides:
- __construct()
abstract function getCompositionArgs()
abstract function getCompositionSources($days, $extra_days)
public function getData($days)
- Overrides:
- getData($days)
- Returns:
an array of (columns => [column], data => [(date, value)], last_updated => (date or false))
abstract function getHeadingTitle($key, $args)
e.g. #get_exchange_name
public function hasSubheading()
Does this graph have a subheading? By default, returns
true. (from hasSubheading)
- Overrides:
- hasSubheading()
- See:
public function isDaily()
- Returns:
true if data should be limited to days, or false if it can have any resolution. defaults to true
public function requiresUser()
Does rendering this graph require a user? By default, returns
false. (from requiresUser)
- Overrides:
- requiresUser()
public function usesSummaries()
Does this graph use summaries which may be out of date for a user? By default, returns
false. (from usesSummaries)
- Overrides:
- usesSummaries()