summaryrefslogtreecommitdiffstats
path: root/lib/ocs/result.php
diff options
context:
space:
mode:
authorTom Needham <needham.thomas@gmail.com>2012-12-31 15:47:15 +0000
committerTom Needham <needham.thomas@gmail.com>2012-12-31 15:47:15 +0000
commit6eb194b70284d527a182756f2c7a21f3d7dc1fe8 (patch)
treee70635e44cc4fccbbde34bed1a01fd50fcd183cf /lib/ocs/result.php
parent218a5ea89014322592bd8c4789d8500d42029b9f (diff)
parent329bddab481129b480ca187b694e507eff7fb125 (diff)
downloadnextcloud-server-6eb194b70284d527a182756f2c7a21f3d7dc1fe8.tar.gz
nextcloud-server-6eb194b70284d527a182756f2c7a21f3d7dc1fe8.zip
Merge branch 'master' into ocs_api
Conflicts: l10n/templates/core.pot l10n/templates/files.pot l10n/templates/files_encryption.pot l10n/templates/files_external.pot l10n/templates/files_sharing.pot l10n/templates/files_versions.pot l10n/templates/lib.pot l10n/templates/settings.pot l10n/templates/user_ldap.pot l10n/templates/user_webdavauth.pot
Diffstat (limited to 'lib/ocs/result.php')
-rw-r--r--lib/ocs/result.php44
1 files changed, 32 insertions, 12 deletions
diff --git a/lib/ocs/result.php b/lib/ocs/result.php
index 4531da5ae0d..b08d911f785 100644
--- a/lib/ocs/result.php
+++ b/lib/ocs/result.php
@@ -1,16 +1,36 @@
<?php
+/**
+* ownCloud
+*
+* @author Tom Needham
+* @copyright 2012 Tom Needham tom@owncloud.com
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
+*
+*/
class OC_OCS_Result{
- private $data, $message, $statuscode, $items, $perpage;
+ private $data, $message, $statusCode, $items, $perPage;
/**
* create the OCS_Result object
* @param $data mixed the data to return
*/
- public function __construct($data=null, $code=100, $message=null){
+ public function __construct($data=null, $code=100, $message=null) {
$this->data = $data;
- $this->statuscode = $code;
+ $this->statusCode = $code;
$this->message = $message;
}
@@ -18,7 +38,7 @@ class OC_OCS_Result{
* optionally set the total number of items available
* @param $items int
*/
- public function setTotalItems(int $items){
+ public function setTotalItems(int $items) {
$this->items = $items;
}
@@ -26,25 +46,25 @@ class OC_OCS_Result{
* optionally set the the number of items per page
* @param $items int
*/
- public function setItemsPerPage(int $items){
- $this->perpage = $items;
+ public function setItemsPerPage(int $items) {
+ $this->perPage = $items;
}
/**
* returns the data associated with the api result
* @return array
*/
- public function getResult(){
+ public function getResult() {
$return = array();
$return['meta'] = array();
- $return['meta']['status'] = ($this->statuscode === 100) ? 'ok' : 'failure';
- $return['meta']['statuscode'] = $this->statuscode;
+ $return['meta']['status'] = ($this->statusCode === 100) ? 'ok' : 'failure';
+ $return['meta']['statuscode'] = $this->statusCode;
$return['meta']['message'] = $this->message;
- if(isset($this->items)){
+ if(isset($this->items)) {
$return['meta']['totalitems'] = $this->items;
}
- if(isset($this->perpage)){
- $return['meta']['itemsperpage'] = $this->perpage;
+ if(isset($this->perPage)) {
+ $return['meta']['itemsperpage'] = $this->perPage;
}
$return['data'] = $this->data;
// Return the result data.