summaryrefslogtreecommitdiffstats
path: root/library/Cube/Dimension.php
blob: 071e934127b286bb0836f9af4cbd5b910b1f8b64 (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
<?php

// Icinga Web 2 Cube Module | (c) 2016 Icinga GmbH | GPLv2

namespace Icinga\Module\Cube;

/**
 * Dimension interface
 *
 * All available dimensions must implement this interface
 *
 * @package Icinga\Module\Cube
 */
interface Dimension
{
    /**
     * The name of this dimension
     *
     * @return string
     */
    public function getName();

    /**
     * Fetch label of this dimension
     *
     * @return string
     */
    public function getLabel();

    /**
     * Add a label
     *
     * @param string $label
     *
     * @return $this
     */
    public function addLabel(string $label);

    /**
     * Set the label for the dimension
     *
     * @param string $label
     *
     * @return $this
     */
    public function setLabel(string $label);

    /**
     * Column expression
     *
     * This is the expression used to fetch the related column. Usually an SQL
     * snippet when a relational database is involved
     *
     * @param Cube $cube
     *
     * @return string
     */
    public function getColumnExpression(Cube $cube);

    /**
     * Add this dimension to a cube
     *
     * This allows your dimension to apply itself to the Cube. That way your
     * dimension is able to join optional tables and more
     *
     * @param Cube $cube
     * @return void
     */
    public function addToCube(Cube $cube);
}