File: CompliancePolicyEnforcedSetting.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (70 lines) | stat: -rw-r--r-- 1,851 bytes parent folder | download
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
<?php

namespace Piwik\Plugins\PrivacyManager\Settings;

use Piwik\Settings\Interfaces\PolicyComparisonInterface;
use Piwik\Settings\Interfaces\SettingValueInterface;
use Piwik\Settings\Interfaces\Traits\PolicyComparisonTrait;

/**
 * Settings extending this abstract class will be enforced when the policy is enforced
 *
 * @implements PolicyComparisonInterface<bool>
 * @implements SettingValueInterface<bool>
 */
abstract class CompliancePolicyEnforcedSetting implements
    PolicyComparisonInterface,
    SettingValueInterface
{
    /** @use PolicyComparisonTrait<bool> */
    use PolicyComparisonTrait;

    /** @var bool */
    private $value;

    abstract public static function getTitle(): string;

    abstract public static function getComplianceRequirementNote(?int $idSite = null): string;

    abstract public static function getPolicyRequirements(): array;

    protected function __construct(bool $value)
    {
        $this->value = $value;
    }

    public static function getInlineHelp(): string
    {
        return '';
    }

    protected static function compareStrictness($value1, $value2)
    {
        return $value1 || $value2;
    }

    public static function getInstance(?int $idSite = null): self
    {
        $values = self::getPolicyRequiredValues($idSite);
        $strictest = (bool) self::getStrictestValueFromArray($values);

        return new static($strictest);
    }

    public static function isCompliant(string $policy, ?int $idSite = null): bool
    {
        $policyValues = static::getPolicyRequirements();
        if (!array_key_exists($policy, $policyValues)) {
            return true;
        }

        $currentValue = self::getInstance($idSite)->getValue();

        return $currentValue === $policyValues[$policy];
    }

    public function getValue()
    {
        return $this->value;
    }
}