blob: 5460a8b275cf3ea5987a718c410234693500c9c9 (
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
<?php
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\OCS;
class Result {
protected array $data;
/** @var null|string */
protected ?string $message;
/** @var int */
protected int $statusCode;
/** @var integer */
protected $items;
/** @var integer */
protected $perPage;
/** @var array */
private array $headers = [];
/**
* create the OCS_Result object
*
* @param mixed|null $data the data to return
* @param int $code
* @param string|null $message
* @param array $headers
*/
public function __construct(mixed $data = null, int $code = 100, ?string $message = null, array $headers = []) {
if ($data === null) {
$this->data = [];
} elseif (!is_array($data)) {
$this->data = [$this->data];
} else {
$this->data = $data;
}
$this->statusCode = $code;
$this->message = $message;
$this->headers = $headers;
}
/**
* optionally set the total number of items available
*
* @param int $items
*/
public function setTotalItems(int $items): void {
$this->items = $items;
}
/**
* optionally set the number of items per page
*
* @param int $items
*/
public function setItemsPerPage(int $items): void {
$this->perPage = $items;
}
/**
* get the status code
* @return int
*/
public function getStatusCode(): int {
return $this->statusCode;
}
/**
* get the meta data for the result
* @return array
*/
public function getMeta(): array {
$meta = [];
$meta['status'] = $this->succeeded() ? 'ok' : 'failure';
$meta['statuscode'] = $this->statusCode;
$meta['message'] = $this->message;
if ($this->items !== null) {
$meta['totalitems'] = $this->items;
}
if ($this->perPage !== null) {
$meta['itemsperpage'] = $this->perPage;
}
return $meta;
}
/**
* get the result data
* @return array
*/
public function getData(): array {
return $this->data;
}
/**
* return bool Whether the method succeeded
* @return bool
*/
public function succeeded(): bool {
return ($this->statusCode == 100);
}
/**
* Adds a new header to the response
*
* @param string $name The name of the HTTP header
* @param string $value The value, null will delete it
* @return $this
*/
public function addHeader(string $name, ?string $value): static {
$name = trim($name); // always remove leading and trailing whitespace
// to be able to reliably check for security
// headers
if (is_null($value)) {
unset($this->headers[$name]);
} else {
$this->headers[$name] = $value;
}
return $this;
}
/**
* Returns the set headers
* @return array the headers
*/
public function getHeaders(): array {
return $this->headers;
}
}
|
