67 lines
1.2 KiB
PHP
67 lines
1.2 KiB
PHP
<?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();
|
|
} |