core/Archive/Parameters.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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

<?php

namespace Piwik;
use Exception;
use Piwik\Segment;

class Archive_Parameters
{
    /**
     * The list of site IDs to query archive data for.
     *
     * @var array
     */
    private $idSites = array();

    /**
     * The list of Period's to query archive data for.
     *
     * @var array
     */
    private $periods = array();

    /**
     * Segment applied to the visits set.
     *
     * @var Segment
     */
    private $segment;

    public function getSegment()
    {
        return $this->segment;
    }

    public function setSegment(Segment $segment)
    {
        $this->segment = $segment;
    }

    public function getPeriods()
    {
        return $this->periods;
    }

    public function setPeriods($periods)
    {
        $this->periods = $this->getAsNonEmptyArray($periods, 'periods');
    }

    public function getIdSites()
    {
        return $this->idSites;
    }

    public function setIdSites($idSites)
    {
        $this->idSites = $this->getAsNonEmptyArray($idSites, 'idSites');
    }

    private function getAsNonEmptyArray($array, $paramName)
    {
        if (!is_array($array)) {
            $array = array($array);
        }

        if (empty($array)) {
            throw new Exception("Archive::__construct: \$$paramName is empty.");
        }

        return $array;
    }
}