core/Archive/ArchiveQuery.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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

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


use Piwik\DataTable;

interface ArchiveQuery
{
    /**
     * @param string|string[] $names
     * @return false|number|array
     */
    public function getNumeric($names);

    /**
     * @param string|string[] $names
     * @return DataTable|DataTable\Map
     */
    public function getDataTableFromNumeric($names);

    /**
     * @param $names
     * @return mixed
     */
    public function getDataTableFromNumericAndMergeChildren($names);

    /**
     * @param string $name
     * @param int|string|null $idSubtable
     * @return DataTable|DataTable\Map
     */
    public function getDataTable($name, $idSubtable = null);

    /**
     * @param string $name
     * @param int|string|null $idSubtable
     * @param int|null $depth
     * @param bool $addMetadataSubtableId
     * @return DataTable|DataTable\Map
     */
    public function getDataTableExpanded($name, $idSubtable = null, $depth = null, $addMetadataSubtableId = true);
}