1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Tour;
use Piwik\Piwik;
use Piwik\Plugins\Tour\Engagement\Levels;
use Piwik\Plugins\Tour\Engagement\Challenges;
/**
* API for Tour plugin which helps you getting familiar with Matomo.
*
* @method static \Piwik\Plugins\Tour\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
/**
* @var Challenges
*/
private $challenges;
/**
* Levels
*/
private $levels;
public function __construct(Challenges $challenges, Levels $levels)
{
$this->challenges = $challenges;
$this->levels = $levels;
}
/**
* Get all challenges that can be completed by a super user.
*
* @return array[]
*/
public function getChallenges()
{
Piwik::checkUserHasSuperUserAccess();
$challenges = array();
foreach ($this->challenges->getChallenges() as $challenge) {
$challenges[] = array(
'id' => $challenge->getId(),
'name' => $challenge->getName(),
'description' => $challenge->getDescription(),
'isCompleted' => $challenge->isCompleted(),
'isSkipped' => $challenge->isSkipped(),
'url' => $challenge->getUrl()
);
}
return $challenges;
}
/**
* Skip a specific challenge.
*
* @param string $id
* @return bool
* @throws \Exception
*/
public function skipChallenge($id)
{
Piwik::checkUserHasSuperUserAccess();
foreach ($this->challenges->getChallenges() as $challenge) {
if ($challenge->getId() === $id) {
if (!$challenge->isCompleted()) {
$challenge->skipChallenge();
return true;
}
throw new \Exception('Challenge already completed');
}
}
throw new \Exception('Challenge not found');
}
/**
* Get details about the current level this user has progressed to.
* @return array
*/
public function getLevel()
{
Piwik::checkUserHasSuperUserAccess();
return array(
'description' => $this->levels->getCurrentDescription(),
'currentLevel' => $this->levels->getCurrentLevel(),
'currentLevelName' => $this->levels->getCurrentLevelName(),
'nextLevelName' => $this->levels->getNextLevelName(),
'numLevelsTotal' => $this->levels->getNumLevels(),
'challengesNeededForNextLevel' => $this->levels->getNumChallengesNeededToNextLevel(),
);
}
}
|
