core/DataTable/Filter/PrependSegment.php


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

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\DataTable\Filter;

use Piwik\DataTable;

/**
 * Executes a callback for each row of a {@link DataTable} and prepends each existing segment with the
 * given segment.
 *
 * **Basic usage example**
 *
 *     $dataTable->filter('PrependSegment', array('segmentName==segmentValue;'));
 *
 * @api
 */
class PrependSegment extends PrependValueToMetadata
{
    /**
     * @param DataTable $table
     * @param string $prependSegment The segment to prepend if a segment is already defined. Make sure to include
     *                               A condition, eg the segment should end with ';' or ','
     */
    public function __construct($table, $prependSegment = '')
    {
        parent::__construct($table, 'segment', $prependSegment);
    }
}