Generally you want to use CakeRequest::accept() to get a simple list
of the accepted content types.
| public parseAccept ( ) : array | ||
| return | array | An array of prefValue => array(content/types) |
/**
* Determines which content-types the client prefers. If no parameters are given,
* the single content-type that the client most likely prefers is returned. If $type is
* an array, the first item in the array that the client accepts is returned.
* Preference is determined primarily by the file extension parsed by the Router
* if provided, and secondarily by the list of content-types provided in
* HTTP_ACCEPT.
*
* @param string|array $type An optional array of 'friendly' content-type names, i.e.
* 'html', 'xml', 'js', etc.
* @return mixed If $type is null or not provided, the first content-type in the
* list, based on preference, is returned. If a single type is provided
* a boolean will be returned if that type is preferred.
* If an array of types are provided then the first preferred type is returned.
* If no type is provided the first preferred type is returned.
* @see RequestHandlerComponent::setContent()
*/
public function prefers($type = null)
{
$acceptRaw = $this->request->parseAccept();
if (empty($acceptRaw)) {
return $this->ext;
}
$accepts = $this->mapType(array_shift($acceptRaw));
if (!$type) {
if (empty($this->ext) && !empty($accepts)) {
return $accepts[0];
}
return $this->ext;
}
$types = (array) $type;
if (count($types) === 1) {
if (!empty($this->ext)) {
return in_array($this->ext, $types);
}
return in_array($types[0], $accepts);
}
$intersect = array_values(array_intersect($accepts, $types));
if (empty($intersect)) {
return false;
}
return $intersect[0];
}
/**
* Test that parsing accept headers with invalid syntax works.
*
* The header used is missing a q value for application/xml.
*
* @return void
*/
public function testParseAcceptInvalidSyntax()
{
$_SERVER['HTTP_ACCEPT'] = 'text/html,application/xhtml+xml,application/xml;image/png,image/jpeg,image/*;q=0.9,*/*;q=0.8';
$request = new CakeRequest('/', false);
$result = $request->parseAccept();
$expected = array('1.0' => array('text/html', 'application/xhtml+xml', 'application/xml', 'image/jpeg'), '0.9' => array('image/*'), '0.8' => array('*/*'));
$this->assertEquals($expected, $result);
}
/**
* Test the raw parsing of accept headers into the q value formatting.
*
* @return void
*/
public function testParseAcceptWithQValue()
{
$_SERVER['HTTP_ACCEPT'] = 'text/html;q=0.8,application/json;q=0.7,application/xml;q=1.0,image/png';
$request = new CakeRequest('/', false);
$result = $request->parseAccept();
$expected = array('1.0' => array('application/xml', 'image/png'), '0.8' => array('text/html'), '0.7' => array('application/json'));
$this->assertEquals($expected, $result);
}
/**
* Test parsing accept with a confusing accept value.
*
* @return void
*/
public function testParseAcceptNoQValues()
{
$_SERVER['HTTP_ACCEPT'] = 'application/json, text/plain, */*';
$request = new CakeRequest('/', false);
$result = $request->parseAccept();
$expected = array('1.0' => array('application/json', 'text/plain', '*/*'));
$this->assertEquals($expected, $result);
}