diff options
Diffstat (limited to 'plugins/Live/ProfileSummary/ProfileSummaryAbstract.php')
-rw-r--r-- | plugins/Live/ProfileSummary/ProfileSummaryAbstract.php | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/plugins/Live/ProfileSummary/ProfileSummaryAbstract.php b/plugins/Live/ProfileSummary/ProfileSummaryAbstract.php new file mode 100644 index 0000000000..e1e0f7d0bb --- /dev/null +++ b/plugins/Live/ProfileSummary/ProfileSummaryAbstract.php @@ -0,0 +1,67 @@ +<?php +/** + * Piwik - free/libre analytics platform + * + * @link http://piwik.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + * + */ +namespace Piwik\Plugins\Live\ProfileSummary; + +/** + * Class ProfileSummaryAbstract + * + * This class can be implemented in a plugin to provide a new profile summary + * + * @api + */ +abstract class ProfileSummaryAbstract +{ + /** + * Visitor profile information + * + * @var array + */ + protected $profile = []; + + /** + * Set profile information + * + * @param array $profile + */ + public function setProfile($profile) + { + $this->profile = $profile; + } + + /** + * Returns the unique ID + * + * @return string + */ + public function getId() + { + return static::class; + } + + /** + * Returns the descriptive name + * + * @return string + */ + abstract function getName(); + + /** + * Renders and returns the summary + * + * @return string + */ + abstract function render(); + + /** + * Returns order indicator used to sort all summaries before displaying them + * + * @return int + */ + abstract function getOrder(); +}
\ No newline at end of file |