Piwik\Plugins\CoreHome\SystemSummary\

Item

This class can be used to add a new entry / item to the system summary widget.

Methods

The class defines the following methods:

• __construct() — Item constructor.
• getKey()
• getLabel()
• getValue()
• getUrlParams()
• getIcon()
• getOrder()

__construct()

Item constructor.

Signature

• It accepts the following parameter(s):
  • $key (string) — The key or ID for this item. The entry in the widget will have this class so it is possible to style it individually and other plugins can use this key to for example remove this item from the list of system summary items.
  • $label (string) — The label that will be displayed for this item. The label may already include the value such as "5 segments"
  • $value (string|null) — Optional label. If given, the value will be displayed after the label separated by a colon, eg: "Segments: 5"
  • $urlParams (array|null) — Optional URL to make the item clickable. Accepts an array of URL parameters that need to be modfified.
  • $icon (string) — Optional icon css class, eg "icon-user".
  • $order (int) — Optional sort order. The lower the value, the higher up the entry will be shown

getKey()

Signature

• It returns a string value.

getLabel()

Signature

• It returns a string value.

getValue()

Signature

• It returns a mixed value.

getUrlParams()

Signature

• Returns: array|null —

getIcon()

Signature

• It returns a string value.

getOrder()

Signature

• It returns a int value.