ForumSubscriptions.php
4.13 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
<?php
namespace Zendesk\API;
/**
* The ForumSubscriptions class exposes forum information
* @package Zendesk\API
*/
class ForumSubscriptions extends ClientAbstract
{
const OBJ_NAME = 'forum_subscription';
const OBJ_NAME_PLURAL = 'forum_subscriptions';
/**
* List all forum subscriptions
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function findAll(array $params = array())
{
if ($this->client->forums()->getLastId() != null) {
$params['forum_id'] = $this->client->forums()->getLastId();
$this->client->forums()->setLastId(null);
}
$endPoint = Http::prepare((isset($params['forum_id']) ? 'forum/' . $params['forum_id'] . '/subscriptions.json' : 'forum_subscriptions.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 subscription
*
* @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('forum_subscriptions/' . $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 subscription
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function create(array $params)
{
if ($this->client->users()->getLastId() != null) {
$params['user_id'] = $this->client->users()->getLastId();
$this->client->users()->setLastId(null);
}
if ($this->client->forums()->getLastId() != null) {
$params['forum_id'] = $this->client->forums()->getLastId();
$this->client->forums()->setLastId(null);
}
if (!$this->hasKeys($params, array('user_id', 'forum_id'))) {
throw new MissingParametersException(__METHOD__, array('user_id', 'forum_id'));
}
$endPoint = Http::prepare('forum_subscriptions.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;
}
/**
* Delete a forum subscription
*
* @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('forum_subscriptions/' . $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;
}
}