Package org.ametys.plugins.webanalytics.matomo

Class MatomoDataHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.webanalytics.matomo.MatomoDataHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component

public class MatomoDataHelper
extends AbstractLogEnabled
implements Component, Initializable

The matomo data helper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	MatomoDataHelper.NbVisits	Record representing the number of visits at the given local date
protected class	MatomoDataHelper.NbVisitsCacheLoader	The cache loader for the number of visits

Field Summary

Fields

Modifier and Type	Field	Description
protected LoadingCache<org.ametys.plugins.webanalytics.matomo.MatomoDataHelper.MatomoCacheKey,MatomoDataHelper.NbVisits>	_dataCache	The user information cache.
static final String	MATOMO_SITE_ID_SITE_CONFIG	The Matomo site id config parameter name
static final String	MATOMO_URL_CONFIG	The Matomo URL config parameter name
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
MatomoDataHelper()

Method Summary

Modifier and Type	Method	Description
protected int	_getComputedVisitsFromBeginYear(String siteId, String pageUrl, String beginYear)	Get the computed number of visits from the last years starting from the begin year for the given page and site
protected int	_getComputedVisitsFromLastDays(String siteId, String pageUrl, long nbDay)	Get the computed number of visits from the last n days (starting from yesterday) for the given page and site
protected int	_getComputedVisitsOfCurrentDay(String siteId, String pageUrl)	Get the computed number of visits of today for the given page and site
protected int	_getLiveVisitsOfDay(String siteId, String pageUrl, Long cacheValidityInMinutes)	Get the live number of visits of today for the given page and site
long	getMatomoSiteNbLastDays(Site site)	Get the number of days from now to computed the number of visits
int	getNbTotalVisits(Site site, String pageUrl)	Get the number of visits since the begin year for the given page and site
int	getNbVisitsFromLastDays(Site site, String pageUrl)	Get the number of visits from the last days for the given page and site
void	initialize()

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The component role.

MATOMO_URL_CONFIG

public static final String MATOMO_URL_CONFIG

The Matomo URL config parameter name

See Also:

• Constant Field Values

MATOMO_SITE_ID_SITE_CONFIG

public static final String MATOMO_SITE_ID_SITE_CONFIG

The Matomo site id config parameter name

See Also:

• Constant Field Values

_dataCache

protected LoadingCache<org.ametys.plugins.webanalytics.matomo.MatomoDataHelper.MatomoCacheKey,MatomoDataHelper.NbVisits> _dataCache

The user information cache.

Constructor Details

MatomoDataHelper

public MatomoDataHelper()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getMatomoSiteNbLastDays

public long getMatomoSiteNbLastDays(Site site)

Get the number of days from now to computed the number of visits

Parameters:

site - the site

Returns:

the number of days

getNbTotalVisits

public int getNbTotalVisits(Site site,
 String pageUrl)
                     throws MatomoException

Get the number of visits since the begin year for the given page and site

Parameters:

site - the site

pageUrl - the page URL

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred

getNbVisitsFromLastDays

public int getNbVisitsFromLastDays(Site site,
 String pageUrl)
                            throws MatomoException

Get the number of visits from the last days for the given page and site

Parameters:

site - the site

pageUrl - the page URL

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred

_getLiveVisitsOfDay

protected int _getLiveVisitsOfDay(String siteId,
 String pageUrl,
 Long cacheValidityInMinutes)
                           throws MatomoException

Get the live number of visits of today for the given page and site

Parameters:

siteId - the site identifier in Matomo

pageUrl - the page URL

cacheValidityInMinutes - the number of minute of the cache validity

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred

_getComputedVisitsFromBeginYear

protected int _getComputedVisitsFromBeginYear(String siteId,
 String pageUrl,
 String beginYear)
                                       throws MatomoException

Get the computed number of visits from the last years starting from the begin year for the given page and site

Parameters:

siteId - the site identifier in matomo

pageUrl - the page URL

beginYear - the begin year

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred

_getComputedVisitsOfCurrentDay

protected int _getComputedVisitsOfCurrentDay(String siteId,
 String pageUrl)
                                      throws MatomoException

Get the computed number of visits of today for the given page and site

Parameters:

siteId - the site identifier in matomo

pageUrl - the page URL

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred

_getComputedVisitsFromLastDays

protected int _getComputedVisitsFromLastDays(String siteId,
 String pageUrl,
 long nbDay)
                                      throws MatomoException

Get the computed number of visits from the last n days (starting from yesterday) for the given page and site

Parameters:

siteId - the site identifier in matomo

pageUrl - the page URL

nbDay - the number of day

Returns:

the number of visits

Throws:

MatomoException - if an error with Matomo occurred