summaryrefslogtreecommitdiffstats
path: root/lib/kolab_client_api_result.php
blob: 0bf86d8e1c7c11e7cf85aecb0e4b93758a655f1e (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<?php
/*
 +--------------------------------------------------------------------------+
 | This file is part of the Kolab Web Admin Panel                           |
 |                                                                          |
 | Copyright (C) 2011-2012, Kolab Systems AG                                |
 |                                                                          |
 | This program is free software: you can redistribute it and/or modify     |
 | it under the terms of the GNU Affero General Public License as published |
 | by the Free Software Foundation, either version 3 of the License, or     |
 | (at your option) any later version.                                      |
 |                                                                          |
 | This program is distributed in the hope that it will be useful,          |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of           |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the             |
 | GNU Affero General Public License for more details.                      |
 |                                                                          |
 | You should have received a copy of the GNU Affero General Public License |
 | along with this program. If not, see <http://www.gnu.org/licenses/>      |
 +--------------------------------------------------------------------------+
 | Author: Aleksander Machniak <machniak@kolabsys.com>                      |
 +--------------------------------------------------------------------------+
*/

/**
 * API result wrapper
 */
class kolab_client_api_result
{
    /**
     * @var array
     */
    private $data = array();

    private $error_code;
    private $error_str;


    /**
     * Class constructor.
     *
     * @param array $data        Result data
     * @param int   $error_code  Error code
     * @param string $error_str  Error message
     */
    public function __construct($data = array(), $error_code = null, $error_str = null)
    {
        if (is_array($data) && isset($data['result'])) {
            $this->data = $data['result'];
        }

        $this->error_code = $error_code;
        $this->error_str = $error_str;
    }

    /**
     * Error code getter.
     *
     * @return int Error code
     */
    public function get_error_code()
    {
        return $this->error_code;
    }

    /**
     * Error message getter.
     *
     * @return string Error message
     */
    public function get_error_str()
    {
        return $this->error_str;
    }

    /**
     * Response data getter.
     *
     * @param string $name Response member name
     *
     * @return array|string Data member or complete response data (when $name is null)
     */
    public function get($name = null)
    {
        if ($name !== null) {
            return isset($this->data[$name]) ? $this->data[$name] : null;
        }

        return $this->data;
    }
}