plugins/Tour/Engagement/ChallengeSetupConsentManager.php


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

<?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\Engagement;

use Piwik\Piwik;
use Piwik\SiteContentDetector;


class ChallengeSetupConsentManager extends Challenge
{

    /** @var SiteContentDetector */
    private $siteContentDetector;


    /**
     * @param SiteContentDetector $siteContentDetector
     * @param string|null         $siteData    String of site content, content of the current site will be retrieved if left blank
     */
    public function __construct(SiteContentDetector $siteContentDetector, ?string $siteData = null)
    {
        parent::__construct();
        $this->siteContentDetector = $siteContentDetector;
        $this->siteContentDetector->detectContent([SiteContentDetector::CONSENT_MANAGER], null, $siteData);
    }

    public function getName()
    {
        return Piwik::translate('Tour_ConnectConsentManager', [$this->siteContentDetector->consentManagerName]);
    }

    public function getDescription()
    {
        return Piwik::translate('Tour_ConnectConsentManagerIntro', [$this->siteContentDetector->consentManagerName]);
    }

    public function getId()
    {
        return 'setup_consent_manager';
    }

    public function getConsentManagerId()
    {
        return $this->siteContentDetector->consentManagerId;
    }

    public function isCompleted()
    {

        if (!$this->siteContentDetector->consentManagerId) {
            return true;
        }

        return $this->siteContentDetector->isConnected;
    }

    public function isDisabled()
    {
        return ($this->siteContentDetector->consentManagerId === null);
    }

    public function getUrl()
    {
        if ($this->siteContentDetector->consentManagerId === null) {
            return '';
        }

        return $this->siteContentDetector->consentManagerUrl;
    }

}