ecommun / owncloud_ynh

Blame view

sources/lib/private/ocs/result.php 2.17 KB
edit raw normal view history
03e52840d   Kload   Init 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
  <?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{
31b7f2792   Kload   Upgrade to ownclo... 
24
 
  	protected $data, $message, $statusCode, $items, $perPage;
03e52840d   Kload   Init 
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
92
93
 
  
  	/**
  	 * create the OCS_Result object
  	 * @param $data mixed the data to return
  	 */
  	public function __construct($data=null, $code=100, $message=null) {
  		$this->data = $data;
  		$this->statusCode = $code;
  		$this->message = $message;
  	}
  
  	/**
  	 * optionally set the total number of items available
  	 * @param $items int
  	 */
  	public function setTotalItems(int $items) {
  		$this->items = $items;
  	}
  
  	/**
  	 * optionally set the the number of items per page
  	 * @param $items int
  	 */
  	public function setItemsPerPage(int $items) {
  		$this->perPage = $items;
  	}
  	
  	/**
  	 * get the status code
  	 * @return int
  	 */
  	public function getStatusCode() {
  		return $this->statusCode;
  	}
  	
  	/**
  	 * get the meta data for the result
  	 * @return array
  	 */
  	public function getMeta() {
  		$meta = array();
  		$meta['status'] = ($this->statusCode === 100) ? 'ok' : 'failure';
  		$meta['statuscode'] = $this->statusCode;
  		$meta['message'] = $this->message;
  		if(isset($this->items)) {
  			$meta['totalitems'] = $this->items;
  		}
  		if(isset($this->perPage)) {
  			$meta['itemsperpage'] = $this->perPage;
  		}
  		return $meta;
  
  	}
  	
  	/**
  	 * get the result data
  	 * @return array|string|int 
  	 */
  	public function getData() {
  		return $this->data;
  	}
  	
  	/**
  	 * return bool if the method succedded
  	 * @return bool
  	 */
  	public function succeeded() {
  		return (substr($this->statusCode, 0, 1) === '1');
  	}
31b7f2792   Kload   Upgrade to ownclo... 
94
 
  }