Package org.ametys.plugins.webanalytics.matomo.tracking

Class AbstractMatomoEventTrackingProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.webanalytics.matomo.tracking.AbstractMatomoEventTrackingProvider

All Implemented Interfaces:

MatomoTrackingProvider, LogEnabled, Configurable

Direct Known Subclasses:

LikeMatomoTrackingProvider, LinkDirectoryMatomoTrackingProvider, PageSubscriptionMatomoTrackingProvider, TagSubscriptionMatomoTrackingProvider

public abstract class AbstractMatomoEventTrackingProvider
extends AbstractLogEnabled
implements MatomoTrackingProvider, Configurable

Abstract class for Matomo tracking provider. It provide only {#MatomoRequests.event}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractMatomoEventTrackingProvider.MatomoEvent	Record for a matomo event

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_eventsAction	The events category
protected String	_eventsCategory	The events category

Constructor Summary

Constructors

Constructor	Description
AbstractMatomoEventTrackingProvider()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
protected abstract List<AbstractMatomoEventTrackingProvider.MatomoEvent>	getEvents(Site site)	Get the list of event to send to matomo
protected String	getEventsAction()	The events action
protected String	getEventsCategory()	The events category
List<org.matomo.java.tracking.MatomoRequest>	getRequests(Site site)	Get the list of request to send to Matomo

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

_eventsCategory

protected String _eventsCategory

The events category

_eventsAction

protected String _eventsAction

The events category

Constructor Details

AbstractMatomoEventTrackingProvider

public AbstractMatomoEventTrackingProvider()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getRequests

public List<org.matomo.java.tracking.MatomoRequest> getRequests(Site site)

Description copied from interface: MatomoTrackingProvider

Get the list of request to send to Matomo

Specified by:

getRequests in interface MatomoTrackingProvider

Parameters:

site - the site

Returns:

matomo requests

getEventsCategory

protected String getEventsCategory()

The events category

Returns:

the events category

getEventsAction

protected String getEventsAction()

The events action

Returns:

the events action

getEvents

protected abstract List<AbstractMatomoEventTrackingProvider.MatomoEvent> getEvents(Site site)

Get the list of event to send to matomo

Parameters:

site - the site

Returns:

the list of matomo events