Ubuntu
['trait' => SystemGetterTrait::class, 'method' => 'getSystemSettingShortName'], self::SETTING_TYPE_MEASURABLE => ['trait' => MeasurableGetterTrait::class, 'method' => 'getMeasurableSettingShortName'], self::SETTING_TYPE_CUSTOM => ['trait' => CustomGetterTrait::class, 'method' => 'getCustomSettingShortName'], self::SETTING_TYPE_OPTION => ['trait' => OptionGetterTrait::class, 'method' => 'getOptionSettingShortName'], self::SETTING_TYPE_CONFIG => ['trait' => ConfigGetterTrait::class, 'method' => 'getConfigSettingShortName']];
/**
* @return array>
*/
public static function getAllPolicies() : array
{
return [\Piwik\Policy\CnilPolicy::class];
}
/**
* @return array>
*/
public static function getAllPoliciesDetails() : array
{
$policies = static::getAllPolicies();
return array_map(function ($policyClass) {
return $policyClass::getDetails();
}, $policies);
}
/**
* @return class-string|null
*/
public static function getPolicyByName(string $policyName) : ?string
{
$policies = static::getAllPolicies();
foreach ($policies as $policyClass) {
if ($policyName === $policyClass::getName()) {
return $policyClass;
}
}
return null;
}
/**
* @return array&SettingValueInterface>>
*/
protected static function getAllSettings(?string $settingType = null) : array
{
$settings = Manager::getInstance()->findMultipleComponents('Settings', SettingValueInterface::class);
$underPolicy = [];
// Add core specific settings
$settings[] = ThirdPartyCookies::class;
foreach ($settings as $setting) {
if (!is_a($setting, PolicyComparisonInterface::class, \true)) {
continue;
}
if ($settingType && !in_array(self::$settingTypesMap[$settingType]['trait'], class_uses($setting), \true)) {
continue;
}
$underPolicy[] = $setting;
}
return $underPolicy;
}
/**
* @param class-string $policyClass
* @return array&SettingValueInterface>>
*/
public static function getAllControlledSettings(string $policyClass, ?int $idSite = null, ?string $settingType = null) : array
{
$settings = static::getAllSettings($settingType);
$underPolicy = [];
foreach ($settings as $setting) {
if (!$setting::isControlledBySpecificPolicy($policyClass, $idSite)) {
continue;
}
$underPolicy[] = $setting;
}
return $underPolicy;
}
/**
* @param class-string $policyClass
* @throws CompliancePolicyNotFoundException when $policyClass is not a valid policy
*/
public static function isPolicyActive(string $policyClass, ?int $idSite = null) : bool
{
self::checkPolicyIsValid($policyClass);
return $policyClass::isActive($idSite);
}
/**
* @param class-string $policyClass
* @throws \Exception when $policyClass is not a valid policy
*/
public static function isPolicyConfigControlled(string $policyClass) : bool
{
self::checkPolicyIsValid($policyClass);
return $policyClass::isConfigControlled();
}
/**
* @param class-string $policyClass
* @return array> of [['title' => (string) 'TITLE', 'note' => (string) 'NOTE']]
* @throws CompliancePolicyNotFoundException when $policyClass is not a valid policy
*/
public static function getAllUnknownSettings(string $policyClass) : array
{
self::checkPolicyIsValid($policyClass);
return $policyClass::getUnknownSettings();
}
/**
* @param class-string $policyClass
* @throws CompliancePolicyNotFoundException when $policyClass is not a valid policy
*/
private static function checkPolicyIsValid(string $policyClass) : void
{
if (!is_a($policyClass, \Piwik\Policy\CompliancePolicy::class, \true)) {
throw new CompliancePolicyNotFoundException('Invalid compliance policy.');
}
}
/**
* @param class-string $policyClass
* @throws CompliancePolicyNotFoundException when $policyClass is not a valid policy
*/
public static function setPolicyActiveStatus(string $policyClass, bool $isActive, ?int $idSite = null) : void
{
self::checkPolicyIsValid($policyClass);
$policyClass::setActiveStatus($idSite, $isActive);
if (!is_null($idSite)) {
Cache::deleteCacheWebsiteAttributes($idSite);
}
Cache::deleteTrackerCache();
}
public static function storePolicySettingValuesInTrackerCache(array &$cacheContent, int $idSite) : array
{
$settings = static::getAllSettings();
foreach ($settings as $setting) {
$cacheContent[$setting] = $setting::getInstance($idSite)->getValue();
}
return $cacheContent;
}
/**
* Return setting type from a given Setting instance, including subclasses
*
*/
public static function getSettingTypeFromSettingClass(Setting $setting) : ?string
{
$map = [MeasurableSetting::class => self::SETTING_TYPE_MEASURABLE, MeasurableProperty::class => self::SETTING_TYPE_MEASURABLE, SystemSetting::class => self::SETTING_TYPE_SYSTEM, SystemConfigSetting::class => self::SETTING_TYPE_CONFIG];
foreach ($map as $class => $type) {
if ($setting instanceof $class) {
return $type;
}
}
return null;
}
/**
* For a given setting name, return an information on policies that may control the setting and its required value.
*
* @return array
* @throws Exception
*/
public static function getCompliancePoliciesControllingASetting(string $settingName, ?int $idSite = null, ?string $settingType = null) : array
{
if (!$settingType || !in_array($settingType, array_keys(self::$settingTypesMap), \true)) {
return [];
}
$policies = static::getAllPolicies();
$settings = [];
foreach ($policies as $policyClass) {
if (\false === $policyClass::isActive($idSite)) {
continue;
}
$controlledSettings = self::getAllControlledSettings($policyClass, $idSite, $settingType);
foreach ($controlledSettings as $controlledSetting) {
if ($settingName === call_user_func([$controlledSetting, self::$settingTypesMap[$settingType]['method']])) {
$settings[$policyClass::getName()] = ['requiredValue' => $controlledSetting::getPolicyRequirements()[$policyClass]];
}
}
}
return $settings;
}
}