File: BotRequestProcessor.php

package info (click to toggle)
matomo 5.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 95,068 kB
  • sloc: php: 289,425; xml: 127,249; javascript: 112,130; python: 202; sh: 178; makefile: 20; sql: 10
file content (39 lines) | stat: -rw-r--r-- 957 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

declare(strict_types=1);

namespace Piwik\Tracker;

abstract class BotRequestProcessor
{
    /**
     * This is the first method called when processing a bot request.
     *
     * Derived classes can use this method to manipulate a bot request before the request
     * is handled. Plugins could change the URL, add custom variables, etc.
     *
     */
    public function manipulateRequest(Request $request): void
    {
        // empty
    }

    /**
     * This method is called last.
     *
     * Derived classes should use this method to insert log data.
     *
     * @return bool return true if the processor handled the request, this will automatically trigger archive invalidation
     */
    public function handleRequest(Request $request): bool
    {
        return false;
    }
}