Vperyod\AcceptHandler\AcceptRequestAwareTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setAcceptAttribute()	0	5	1
A	negotiateMedia()	0	4	1
A	negotiateCharset()	0	4	1
A	negotiateLanguage()	0	4	1
A	getAccept()	0	11	2

<?php
/**
 * Accept Handler
 *
 * PHP version 5
 *
 * Copyright (C) 2016 Jake Johns
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 *
 * @category  Trait
 * @package   Vperyod\AcceptHandler
 * @author    Jake Johns <jake@jakejohns.net>
 * @copyright 2016 Jake Johns
 * @license   http://jnj.mit-license.org/2016 MIT License
 * @link      https://github.com/vperyod/vperyod.accept-handler
 */

namespace Vperyod\AcceptHandler;

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

use Aura\Accept\Accept;

/**
 * Accept Request aware trait
 *
 * Trait for objects which need to know where the accept attribute is stored in
 * the request.
 *
 * @category Trait
 * @package  Vperyod\AcceptHandler
 * @author   Jake Johns <jake@jakejohns.net>
 * @license  http://jnj.mit-license.org/2016 MIT License
 * @link     https://github.com/vperyod/vperyod.accept-handler
 */
trait AcceptRequestAwareTrait
{
    /**
     * Attribute on request where accept is stored
     *
     * @var string
     *
     * @access protected
     */
    protected $acceptAttribute = 'aura/accept:accept';

    /**
     * Set accept attribute
     *
     * @param string $attr attribute on request where accept is stored
     *
     * @return $this
     *
     * @access public
     */
    public function setAcceptAttribute($attr)
    {
        $this->acceptAttribute = $attr;
        return $this;
    }

    /**
     * Get accept from request
     *
     * @param Request $request PSR7 Request
     *
     * @return Accept
     * @throws InvalidAcceptException if accept attribute is not an `Accept`
     *
     * @access protected
     */
    protected function getAccept(Request $request)
    {
        $accept = $request->getAttribute($this->acceptAttribute);
        if (! $accept instanceof Accept) {
            throw new Exception\InvalidAcceptException(
                'Accept not available in request at: '
                . $this->acceptAttribute
            );
        }
        return $accept;
    }

    /**
     * Negotiate media
     *
     * @param Request $request   PSR7 Request
     * @param array   $available array of available media types
     *
     * @return Aura\Accept\Media\MediaValue|false
     *
     * @access protected
     */
    protected function negotiateMedia(Request $request, array $available)
    {
        return $this->getAccept($request)->negotiateMedia($available);
    }

    /**
     * Negotiate charset
     *
     * @param Request $request   PSR7 Request
     * @param array   $available array of available charsets
     *
     * @return Aura\Accept\Charset\CharsetValue
     *
     * @access protected
     */
    protected function negotiateCharset(Request $request, array $available)
    {
        return $this->getAccept($request)->negotiateCharset($available);
    }

    /**
     * Negotiate language
     *
     * @param Request $request   PSR7 Request
     * @param array   $available arrayof available languages
     *
     * @return Aura\Accept\Language\LanguageValue
     *
     * @access protected
     */
    protected function negotiateLanguage(Request $request, array $available)
    {
        return $this->getAccept($request)->negotiateLanguage($available);
    }
}