Attachments.php
5.16 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
<?php
namespace Zendesk\API;
/**
* The Attachments class exposes methods for uploading and retrieving attachments
* @package Zendesk\API
*/
class Attachments extends ClientAbstract
{
/**
* Upload an attachment
* $params must include:
* 'file' - an attribute with the absolute local file path on the server
* 'type' - the MIME type of the file
* Optional:
* 'optional_token' - an existing token
* 'name' - preferred filename
*
* @param array $params
*
* @throws CustomException
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function upload(array $params)
{
if (!$this->hasKeys($params, array('file'))) {
throw new MissingParametersException(__METHOD__, array('file'));
}
if (!file_exists($params['file'])) {
throw new CustomException('File ' . $params['file'] . ' could not be found in ' . __METHOD__);
}
if (!$params['name'] && strrpos($params['file'], '/') > -1) {
$path_array = explode('/', $params['file']);
$file_index = count($path_array) - 1;
$params['name'] = $path_array[$file_index];
}
if (!$params['name'] && strrpos($params['file'], '/') == false) {
$params['name'] = $params['file'];
}
$endPoint = Http::prepare('uploads.json?filename=' . urlencode($params['name']) . (isset($params['optional_token']) ? '&token=' . $params['optional_token'] : ''));
$response = Http::send($this->client, $endPoint, array('filename' => $params['file']), 'POST',
(isset($params['type']) ? $params['type'] : 'application/binary'));
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 201)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Upload an attachment from a buffer in memory
* $params must include:
* 'body' - the raw file data to upload
* 'name' - the filename
* 'type' - the MIME type of the file
* Optional:
* 'optional_token' - an existing token
*
* @param array $params
*
* @throws CustomException
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function uploadWithBody(array $params)
{
if (!$this->hasKeys($params, array('body'))) {
throw new MissingParametersException(__METHOD__, array('body'));
}
if (!$params['name']) {
throw new MissingParametersException(__METHOD__, array('name'));
}
$endPoint = Http::prepare('uploads.json?filename=' . $params['name'] . (isset($params['optional_token']) ? '&token=' . $params['optional_token'] : ''));
$response = Http::send($this->client, $endPoint, array('body' => $params['body']), 'POST',
(isset($params['type']) ? $params['type'] : 'application/binary'));
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 201)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/**
* Delete one or more attachments by token or id
* $params must include one of these:
* 'token' - the token given to you after the original upload
* 'id' - the id of the attachment
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return bool
*/
public function delete(array $params)
{
if (!$this->hasAnyKey($params, array('id', 'token'))) {
throw new MissingParametersException(__METHOD__, array('id', 'token'));
}
$endPoint = Http::prepare(($params['token'] ? 'uploads/' . $params['token'] : 'attachments/' . $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;
}
/**
* Get a list of uploaded attachments (by id)
* $params must include:
* 'id' - the id of the attachment
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function find(array $params)
{
if (!$this->hasKeys($params, array('id'))) {
throw new MissingParametersException(__METHOD__, array('id'));
}
$id = $params['id'];
$endPoint = Http::prepare('attachments/' . $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;
}
}