Locales.php
3.11 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
<?php
namespace Zendesk\API;
/**
* The Locales class exposes view management methods
* @package Zendesk\API
*/
class Locales extends ClientAbstract
{
const OBJ_NAME = 'locale';
const OBJ_NAME_PLURAL = 'locales';
/**
* List all locales
*
* @param array $params
*
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function findAll(array $params = array())
{
$endPoint = Http::prepare(
(isset($params['current']) ? 'locales/current.json' :
(isset($params['agent']) ? 'locales/agent.json' : 'locales.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 locale
*
* @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('locales/' . $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;
}
/**
* Detect the best locale from the supplied list
*
* @param array $params
*
* @throws MissingParametersException
* @throws ResponseException
* @throws \Exception
*
* @return mixed
*/
public function detectBest(array $params)
{
if (!$this->hasKeys($params, array('available_locales'))) {
throw new MissingParametersException(__METHOD__, array('available_locales'));
}
$endPoint = Http::prepare('locales/detect_best_locale.json', null, $params);
$response = Http::send($this->client, $endPoint, array('available_locales' => $params['available_locales']),
'GET');
if ((!is_object($response)) || ($this->client->getDebug()->lastResponseCode != 200)) {
throw new ResponseException(__METHOD__);
}
$this->client->setSideload(null);
return $response;
}
/*
* Syntactic sugar methods:
* Handy aliases:
*/
/**
* @throws ResponseException
*
* @return mixed
*/
public function agent()
{
return $this->findAll(array('agent' => true));
}
/**
* @throws ResponseException
*
* @return mixed
*/
public function current()
{
return $this->findAll(array('current' => true));
}
}