Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F117879910
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Authored By
Unknown
Size
3 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/lib/kolab_client_api_result.php b/lib/kolab_client_api_result.php
index a46a369..0bf86d8 100644
--- a/lib/kolab_client_api_result.php
+++ b/lib/kolab_client_api_result.php
@@ -1,64 +1,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;
}
}
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Sun, Apr 5, 11:11 PM (1 w, 6 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18831521
Default Alt Text
(3 KB)
Attached To
Mode
rWAP webadmin
Attached
Detach File
Event Timeline