League\OAuth2\Server\ResponseTypes\DeviceCodeResponse

Complexity

Total Complexity

5

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

86.96%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	generateHttpResponse()	0	27	2
A	setPayload()	0	4	1
A	setDeviceCode()	0	4	1
A	getExtraParams()	0	4	1

<?php
/**
 * OAuth 2.0 Bearer Token Response.
 *
 * @author      Alex Bilbie <hello@alexbilbie.com>
 * @copyright   Copyright (c) Alex Bilbie
 * @license     http://mit-license.org/
 *
 * @link        https://github.com/thephpleague/oauth2-server
 */

namespace League\OAuth2\Server\ResponseTypes;

use League\OAuth2\Server\Entities\DeviceCodeEntityInterface;
use LogicException;
use Psr\Http\Message\ResponseInterface;

class DeviceCodeResponse extends AbstractResponseType
{
    /**
     * @var DeviceCodeEntityInterface
     */
    protected $deviceCode;

    /**
     * @var string
     */
    protected $payload;

    /**
     * {@inheritdoc}
     */
    public function generateHttpResponse(ResponseInterface $response)
    {
        $expireDateTime = $this->deviceCode->getExpiryDateTime()->getTimestamp();

        $responseParams = [
            'expires_in'   => $expireDateTime - \time(),
            'device_code' => $this->payload,
            'user_code' => $this->deviceCode->getUserCode(),
            'verification_uri' => $this->deviceCode->getVerificationUri(),
        ];

        $responseParams = \json_encode($responseParams);

        if ($responseParams === false) {
            throw new LogicException('Error encountered JSON encoding response parameters');
        }

        $response = $response
            ->withStatus(200)
            ->withHeader('pragma', 'no-cache')
            ->withHeader('cache-control', 'no-store')
            ->withHeader('content-type', 'application/json; charset=UTF-8');

        $response->getBody()->write($responseParams);

        return $response;
    }

    public function setPayload($payload)
    {
        $this->payload = $payload;
    }

    /**
     * {@inheritdoc}
     */
    public function setDeviceCode(DeviceCodeEntityInterface $deviceCode)
    {
        $this->deviceCode = $deviceCode;
    }

    /**
     * Add custom fields to your Bearer Token response here, then override
     * AuthorizationServer::getResponseType() to pull in your version of
     * this class rather than the default.
     *
     * @param DeviceCodeEntityInterface $deviceCode
     *
     * @return array
     */
    protected function getExtraParams(DeviceCodeEntityInterface $deviceCode)

The parameter $deviceCode is not used and could be removed.

    {
        return [];
    }
}