softspring/cms-analytics-plugin

Analytics integration plugin for Armonic CMS.

6.0.x-dev 2026-06-25 10:11 UTC

Requires

• php: >=8.4
• softspring/cms-bundle: ^6.0@dev
• symfony/cache-contracts: ^3.5
• symfony/config: ^6.4 || ^7.4 || ^8.0
• symfony/dependency-injection: ^6.4 || ^7.4 || ^8.0
• symfony/framework-bundle: ^6.4 || ^7.4 || ^8.0
• symfony/http-client: ^6.4 || ^7.4 || ^8.0
• symfony/http-client-contracts: ^3.5
• symfony/http-foundation: ^6.4 || ^7.4 || ^8.0
• symfony/http-kernel: ^6.4 || ^7.4 || ^8.0
• symfony/routing: ^6.4 || ^7.4 || ^8.0

Requires (Dev)

• ergebnis/composer-normalize: ^2.50
• friendsofphp/php-cs-fixer: ^3.94
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.5
• rector/rector: ^2.3
• symfony/yaml: ^6.4 || ^7.4 || ^8.0

Suggests

• google/auth: Required only when a site uses the google_analytics_4 analytics driver.

AGPL-3.0-or-later

README

Experimental package: this plugin is in active development and its configuration, analytics provider integration, UI, and extension points may change before a stable release.

softspring/cms-analytics-plugin adds page-level analytics to Armonic CMS administration and exposes a provider-agnostic statistics API for other CMS plugins.

It resolves the configured URLs for a CMS content item, queries the configured statistics provider for each URL, and shows totals and per-URL metrics in the content administration screen. The plugin ships a Plausible provider; projects can add GA4 or other providers behind the same statistics API.

Installation

composer require softspring/cms-analytics-plugin:^6.0@dev

The plugin requires softspring/cms-bundle, Symfony HttpClient, and a cache service.

Register the bundle if Symfony Flex does not do it automatically:

// config/bundles.php
return [
    Softspring\CmsAnalyticsPlugin\SfsCmsAnalyticsPlugin::class => ['all' => true],
];

Configuration

Each CMS site reads provider configuration from site.extra.analytics.

Select the active provider with site.extra.analytics.driver. When no driver is set, the plugin uses the Plausible provider as the default.

Plausible configuration lives under site.extra.analytics.plausible:

site:
    extra:
        analytics:
            driver: plausible
            plausible:
                enabled: true
                api_base_url: '%env(PLAUSIBLE_API_BASE_URL)%'
                api_key: '%env(PLAUSIBLE_STATS_API_KEY)%'
                site_id: '%env(PLAUSIBLE_SITE_ID)%'

Use a Plausible Stats API key. Do not use or share personal account credentials for integration tests. Set real keys in local or deployment secrets, not in committed files.

The default Plausible API base URL is https://plausible.io. Override api_base_url only for self-hosted Plausible installations or compatible endpoints.

Google Analytics 4 configuration lives under site.extra.analytics.google_analytics_4:

site:
    extra:
        analytics:
            driver: google_analytics_4
            google_analytics_4:
                enabled: true
                property_id: '%env(GA4_PROPERTY_ID)%'
                credentials_json: '%env(GA4_CREDENTIALS_JSON)%'
                credentials_path: '%env(GA4_CREDENTIALS_PATH)%'
                dashboard_base_url: 'https://analytics.google.com/analytics/web'

property_id is the numeric GA4 property id. GA4 support needs the optional google/auth package:

composer require google/auth

Use either credentials_json, credentials_path, or neither. When both credential fields are empty, Google application default credentials are used. The selected identity must have read access to the GA4 property.

Usage

The plugin adds a Statistics tab to every CMS content type. It queries the statistics provider once per configured URL of the content and caches each response for 15 minutes through Symfony cache.

Supported ranges are:

• Last 7 days.
• Last 30 days.
• Last 91 days.
• Last 6 months.
• Last 12 months.
• This year.

Extension Points

Add custom analytics providers by implementing Softspring\CmsAnalyticsPlugin\Analytics\StatisticsProviderInterface and tagging the service with sfs_cms_analytics.statistics_provider.

Replace Softspring\CmsAnalyticsPlugin\Analytics\PlausibleConfigurationResolver when a project stores Plausible settings outside CMS site configuration.

Replace Softspring\CmsAnalyticsPlugin\Analytics\PlausibleStatsClient when a project needs a different Plausible cache policy or query shape.

Replace Softspring\CmsAnalyticsPlugin\Analytics\GoogleAnalyticsConfigurationResolver, Softspring\CmsAnalyticsPlugin\Analytics\GoogleAnalyticsAccessTokenProvider, or Softspring\CmsAnalyticsPlugin\Analytics\GoogleAnalyticsDataClient when a project needs custom GA4 configuration, authentication, or query behavior.

Override Twig templates through Symfony template resolution when the admin screen needs project-specific layout or metrics.

Features

See FEATURES.md for the functional scope of this package.

Contributing

See CONTRIBUTING.md.

Report issues and send Pull Requests

Security

See SECURITY.md.

License

This package is free and released under the AGPL-3.0 license.