Forums.php
4.91 KB
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
<?php
namespace Zendesk\API;
/**
* The Forums class exposes forum information
* @package Zendesk\API
*/
class Forums extends ClientAbstract
{
const OBJ_NAME = 'forum';
const OBJ_NAME_PLURAL = 'forums';
/**
* @var ForumSubscriptions
*/
protected $subscriptions;
/**
* @param Client $client
*/
public function __construct(Client $client)
{
parent::__construct($client);
$this->subscriptions = new ForumSubscriptions($client);
}
/**
* List all forums
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function findAll(array $params = array())
{
$endPoint = Http::prepare((isset($params['category_id']) ? 'categories/' . $params['category_id'] . '/forums.json' : 'forums.json'),
null, $params);
$response = Http::send($this->client, $endPoint);
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Show a specific forum
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function find(array $params = array())
{
if ($this->lastId != null) {
$params['id'] = $this->lastId;
$this->lastId = null;
}
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$endPoint = Http::prepare('forums/' . $params['id'] . '.json');
$response = Http::send($this->client, $endPoint);
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Create a new forum
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function create(array $params)
{
$endPoint = Http::prepare('forums.json');
$response = Http::send($this->client, $endPoint, array(self::OBJ_NAME => $params), 'POST');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 201)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Update a forum
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function update(array $params)
{
if ($this->lastId != null) {
$params['id'] = $this->lastId;
$this->lastId = null;
}
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$id = $params['id'];
unset($params['id']);
$endPoint = Http::prepare('forums/' . $id . '.json');
$response = Http::send($this->client, $endPoint, array(self::OBJ_NAME => $params), 'PUT');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Delete a forum
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return bool
*/
public function delete(array $params = array())
{
if ($this->lastId != null) {
$params['id'] = $this->lastId;
$this->lastId = null;
}
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$endPoint = Http::prepare('forums/' . $params['id'] . '.json');
$response = Http::send($this->client, $endPoint, null, 'DELETE');
if ($this->client->getDebug()->lastResponseCode != 200) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return true;
}
/*
* Syntactic sugar methods:
* Handy aliases:
*/
/**
* @param int|null $id
*
* @return ForumSubscriptions
*/
public function subscriptions($id = null)
{
return ($id != null ? $this->subscriptions->setLastId($id) : $this->subscriptions);
}
/**
* @param int $id
*
* @return ForumSubscriptions
*/
public function subscription($id)
{
return $this->subscriptions->setLastId($id);
}
}