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
|
<?php
/**
*
* This file is part of Aura for PHP.
*
* @license http://opensource.org/licenses/bsd-license.php BSD
*
*/
namespace Aura\Accept;
use Aura\Accept\Charset\CharsetNegotiator;
use Aura\Accept\Encoding\EncodingNegotiator;
use Aura\Accept\Language\LanguageNegotiator;
use Aura\Accept\Media\MediaNegotiator;
/**
*
* A collection of negotiator objects.
*
* @package Aura.Accept
*
*/
class Accept
{
/**
*
* The media-type negotiator.
*
* @var MediaNegotiator
*
*/
protected $media;
/**
*
* The charset negotiator.
*
* @var CharsetNegotiator
*
*/
protected $charset;
/**
*
* The encoding negotiator.
*
* @var EncodingNegotiator
*
*/
protected $encoding;
/**
*
* The language negotiator.
*
* @var LanguageNegotiator
*
*/
protected $language;
/**
*
* Constructor.
*
* @param CharsetNegotiator $charset A charset negotiator.
*
* @param EncodingNegotiator $encoding An encoding negotiator.
*
* @param LanguageNegotiator $language A language negotiator.
*
* @param MediaNegotiator $media A media-type negotiator.
*
*/
public function __construct(
CharsetNegotiator $charset,
EncodingNegotiator $encoding,
LanguageNegotiator $language,
MediaNegotiator $media
) {
$this->charset = $charset;
$this->encoding = $encoding;
$this->language = $language;
$this->media = $media;
}
/**
*
* Negotiate between acceptable and available charsets.
*
* @param array $available The list of available charsets, ordered by most
* preferred to least preferred.
*
* @return Charset\CharsetValue
*
*/
public function negotiateCharset(array $available)
{
return $this->parseResult($this->charset->negotiate($available));
}
/**
*
* Negotiate between acceptable and available encodings.
*
* @param array $available The list of available encodings, ordered by most
* preferred to least preferred.
*
* @return Encoding\EncodingValue|false
*
*/
public function negotiateEncoding(array $available)
{
return $this->parseResult($this->encoding->negotiate($available));
}
/**
*
* Negotiate between acceptable and available languages.
*
* @param array $available The list of available languages, ordered by most
* preferred to least preferred.
*
* @return Language\LanguageValue|false
*
*/
public function negotiateLanguage(array $available)
{
return $this->parseResult($this->language->negotiate($available));
}
/**
*
* Negotiate between acceptable and available media types.
*
* @param array $available The list of available media types, ordered by
* most preferred to least preferred.
*
* @return Media\MediaValue|false
*
*/
public function negotiateMedia(array $available)
{
return $this->parseResult($this->media->negotiate($available));
}
/**
*
* Given a negotiation result, return either the acceptable value or the
* available value (or false if negotiation failed).
*
* Sometimes the acceptable value is a wildcard, or none was specified, so
* we have to go with the available value.
*
* @param mixed $result A negotiation result.
*
* @return AbstractValue|false
*
*/
protected function parseResult($result)
{
if (! $result) {
return false;
}
if ($result->acceptable && ! $result->acceptable->isWildcard()) {
return $result->acceptable;
}
return $result->available;
}
}
|