blob: 3cf1348b5bc69840c575fe5463cf9af014856a0a (
plain)
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
<?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\Columns;
use Exception;
use Piwik\Plugins\Actions\Actions\ActionSiteSearch;
/**
* @api
* @since 3.1.0
*/
class Discriminator
{
private $table;
private $discriminatorColumn;
private $discriminatorValue;
/**
* Join constructor.
* @param string $table unprefixed table name
* @param null|string $discriminatorColumn
* @param null|int $discriminatorValue should be only hard coded, safe values.
* @throws Exception
*/
public function __construct($table, $discriminatorColumn = null, $discriminatorValue = null)
{
if (empty($discriminatorColumn) || !isset($discriminatorValue)) {
throw new Exception('Both discriminatorColumn and discriminatorValue need to be defined');
}
$this->table = $table;
$this->discriminatorColumn = $discriminatorColumn;
$this->discriminatorValue = $discriminatorValue;
if (!$this->isValid()) {
// if adding another string value please post an event instead to get a list of allowed values
throw new Exception('$discriminatorValue needs to be null or numeric');
}
}
public function isValid()
{
return isset($this->discriminatorColumn)
&& (is_numeric($this->discriminatorValue) || $this->discriminatorValue == ActionSiteSearch::CVAR_KEY_SEARCH_CATEGORY);
}
/**
* @return string
*/
public function getTable()
{
return $this->table;
}
/**
* @return string
*/
public function getColumn()
{
return $this->discriminatorColumn;
}
/**
* @return int|null
*/
public function getValue()
{
return $this->discriminatorValue;
}
}
|