Package org.ametys.plugins.webanalytics.matomo

Class MatomoAnalyticsProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.analytics.AbstractWebAnalyticsProvider

org.ametys.plugins.webanalytics.matomo.MatomoAnalyticsProvider

All Implemented Interfaces:

DeferredServiceable, LogEnabled, PluginAware, WebAnalyticsProvider, Configurable

public class MatomoAnalyticsProvider
extends AbstractWebAnalyticsProvider
implements DeferredServiceable

The matomo analytics provider

Field Summary

Fields

Modifier and Type	Field	Description
protected MatomoTrackingProviderExtensionPoint	_matomoTrackingEP	The Matomo tracking extension point

Fields inherited from class org.ametys.web.analytics.AbstractWebAnalyticsProvider

_id, _label, _pluginName, _xsltPath, RANDOM_NUMBER_TOKEN

Constructor Summary

Constructors

Constructor	Description
MatomoAnalyticsProvider()

Method Summary

Modifier and Type	Method	Description
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
String	getEventImageUri(Site site, String category, String action, String label, int value, boolean usePlaceholderTokens)	Get the event image URI
String	getEventLinkCampaignParams(Site site, String campaign, String medium, String source)	Get the event link campaign params
void	sendTrackingInformation(Site site)	Send tracking information for the given site

Methods inherited from class org.ametys.web.analytics.AbstractWebAnalyticsProvider

_encodeValue, configure, getId, getLabel, getXSLTPath, setPluginInfo

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

_matomoTrackingEP

protected MatomoTrackingProviderExtensionPoint _matomoTrackingEP

The Matomo tracking extension point

Constructor Details

MatomoAnalyticsProvider

public MatomoAnalyticsProvider()

Method Details

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

getEventImageUri

public String getEventImageUri(Site site,
 String category,
 String action,
 String label,
 int value,
 boolean usePlaceholderTokens)

Description copied from interface: WebAnalyticsProvider

Get the event image URI

Specified by:

getEventImageUri in interface WebAnalyticsProvider

Parameters:

site - the site

category - the event category

action - the event action

label - the event label

value - the event value

usePlaceholderTokens - true to use placeholder tokens in the URI

Returns:

the event image URI

getEventLinkCampaignParams

public String getEventLinkCampaignParams(Site site,
 String campaign,
 String medium,
 String source)

Description copied from interface: WebAnalyticsProvider

Get the event link campaign params

Specified by:

getEventLinkCampaignParams in interface WebAnalyticsProvider

Parameters:

site - the site

campaign - the event campaign

medium - the event medium

source - the event source

Returns:

the event link campaign params

sendTrackingInformation

public void sendTrackingInformation(Site site)
                             throws Exception

Description copied from interface: WebAnalyticsProvider

Send tracking information for the given site

Specified by:

sendTrackingInformation in interface WebAnalyticsProvider

Parameters:

site - the site

Throws:

Exception - if an error occurs