Piwik\Plugin\SettingsProvider::getAllUserSettings PHP Method

getAllUserSettings() public method

Returns all available user settings. A plugin has to specify a file named UserSettings.php containing a class named UserSettings that extends Piwik\Settings\Plugin\UserSettings in order to be considered as a plugin setting. Otherwise the settings for a plugin won't be available.
public getAllUserSettings ( ) : UserSettings[]
return Piwik\Settings\Plugin\UserSettings[] An array containing array([pluginName] => [setting instance]).
    public function getAllUserSettings()
    {
        $cacheId = CacheId::languageAware('AllUserSettings');
        $cache = PiwikCache::getTransientCache();
        if (!$cache->contains($cacheId)) {
            $pluginNames = $this->pluginManager->getActivatedPlugins();
            $byPluginName = array();
            foreach ($pluginNames as $plugin) {
                $component = $this->getUserSettings($plugin);
                if (!empty($component)) {
                    $byPluginName[$plugin] = $component;
                }
            }
            $cache->save($cacheId, $byPluginName);
        }
        return $cache->fetch($cacheId);
    }

Usage Example

Exemplo n.º 1
0
Arquivo: API.php Projeto: piwik/piwik
 /**
  * @internal
  * @return array
  * @throws \Piwik\NoAccessException
  */
 public function getUserSettings()
 {
     Piwik::checkUserIsNotAnonymous();
     $userSettings = $this->settingsProvider->getAllUserSettings();
     return $this->settingsMetadata->formatSettings($userSettings);
 }