MatomoTask
extends AirlayTask
in package
Class MatomoTask.
Sending events and page views to Matomo Analytics.
Table of Contents
- TRACKER_FIELDS = ['url', 'urlReferrer', 'ip', 'browserLanguage', 'userAgent', 'forceVisitDateTime', 'visitorId', 'userId']
- $bodies : array<string|int, mixed>
- mainAction() : void
- processBodies() : void
- Fill and send bulk data.
- processBody() : string|null
- Process every message with new tracker because they can't clear all params between processing.
- abortWorkWithMessage() : never
- getDataSetTitle() : string
- parseFlagsFromParams() : void
- Parse command line arguments from array. Output default values if --help or -h argument specified.
- processMessage() : void
- requestConfirm() : bool
- createMatomoTracker() : MatomoTracker
- Create Matomo tracker from config.
- log() : void
- Log line if debug enabled in config.
Constants
TRACKER_FIELDS
private
mixed
TRACKER_FIELDS
= ['url', 'urlReferrer', 'ip', 'browserLanguage', 'userAgent', 'forceVisitDateTime', 'visitorId', 'userId']
Properties
$bodies
private
array<string|int, mixed>
$bodies
= []
Methods
mainAction()
public
mainAction() : void
Return values
void —processBodies()
Fill and send bulk data.
public
processBodies() : void
Return values
void —processBody()
Process every message with new tracker because they can't clear all params between processing.
public
processBody(array<string|int, mixed> $params) : string|null
For example: userId.
Parameters
- $params : array<string|int, mixed>
-
queue message body
Return values
string|null —tracking URL or null if error occurred
abortWorkWithMessage()
protected
abortWorkWithMessage(string $message) : never
Parameters
- $message : string
Return values
never —getDataSetTitle()
protected
getDataSetTitle(array<string|int, mixed>|DataSetEntity $dataSet) : string
Parameters
- $dataSet : array<string|int, mixed>|DataSetEntity
Return values
string —parseFlagsFromParams()
Parse command line arguments from array. Output default values if --help or -h argument specified.
protected
parseFlagsFromParams(Flags $flags[, array<string|int, mixed> $params = [] ]) : void
Parameters
- $flags : Flags
- $params : array<string|int, mixed> = []
Return values
void —processMessage()
protected
processMessage(AMQPMessage $message, array<string|int, mixed> $body) : void
Parameters
- $message : AMQPMessage
- $body : array<string|int, mixed>
Return values
void —requestConfirm()
protected
requestConfirm(string $message) : bool
Parameters
- $message : string
Return values
bool —createMatomoTracker()
Create Matomo tracker from config.
private
createMatomoTracker() : MatomoTracker
Return values
MatomoTracker —log()
Log line if debug enabled in config.
private
log(string $s[, mixed $force = false ]) : void
Parameters
- $s : string
-
log line
- $force : mixed = false