blob: bb8a7e76eb5e1a0669e6036d83433513ab56ce52 (
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
|
<?php
/**
* GenericResult Result superclass.
*
* @package Elgg.Core
* @subpackage WebServicesAPI
*/
abstract class GenericResult {
/**
* The status of the result.
* @var int
*/
private $status_code;
/**
* Message returned along with the status which is almost always an error message.
* This must be human readable, understandable and localised.
* @var string
*/
private $message;
/**
* Result store.
* Attach result specific informaton here.
*
* @var mixed. Should probably be an object of some sort.
*/
private $result;
/**
* Set a status code and optional message.
*
* @param int $status The status code.
* @param string $message The message.
*
* @return void
*/
protected function setStatusCode($status, $message = "") {
$this->status_code = $status;
$this->message = $message;
}
/**
* Set the result.
*
* @param mixed $result The result
*
* @return void
*/
protected function setResult($result) {
$this->result = $result;
}
/**
* Return the current status code
*
* @return string
*/
protected function getStatusCode() {
return $this->status_code;
}
/**
* Return the current status message
*
* @return string
*/
protected function getStatusMessage() {
return $this->message;
}
/**
* Return the current result
*
* @return string
*/
protected function getResult() {
return $this->result;
}
/**
* Serialise to a standard class.
*
* DEVNOTE: The API is only interested in data, we can not easily serialise
* custom classes without the need for 1) the other side being PHP, 2) you need to have the class
* definition installed, 3) its the right version!
*
* Therefore, I'm not bothering.
*
* Override this to include any more specific information, however api results
* should be attached to the class using setResult().
*
* if $CONFIG->debug is set then additional information about the runtime environment and
* authentication will be returned.
*
* @return stdClass Object containing the serialised result.
*/
public function export() {
global $ERRORS, $CONFIG, $_PAM_HANDLERS_MSG;
$result = new stdClass;
$result->status = $this->getStatusCode();
if ($this->getStatusMessage() != "") {
$result->message = $this->getStatusMessage();
}
$resultdata = $this->getResult();
if (isset($resultdata)) {
$result->result = $resultdata;
}
if (isset($CONFIG->debug)) {
if (count($ERRORS)) {
$result->runtime_errors = $ERRORS;
}
if (count($_PAM_HANDLERS_MSG)) {
$result->pam = $_PAM_HANDLERS_MSG;
}
}
return $result;
}
}
|
