Yiisoft\Yii\Debug\Collector\RequestCollector

Complexity

Total Complexity

9

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Test Coverage

Coverage

97.14%

Importance

Changes	8
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndexData()	0	15	1
A	collect()	0	18	6
A	getCollected()	0	19	1
A	reset()	0	9	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Collector;

use JetBrains\PhpStorm\ArrayShape;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Yiisoft\Yii\Http\Event\AfterRequest;
use Yiisoft\Yii\Http\Event\BeforeRequest;

use function is_object;

final class RequestCollector implements CollectorInterface, IndexCollectorInterface
{
    use CollectorTrait;

    private string $requestUrl = '';
    private string $requestMethod = '';
    private bool $requestIsAjax = false;
    private ?string $userIp = null;
    private int $responseStatusCode = 200;
    private ?ServerRequestInterface $request = null;
    private ?ResponseInterface $response = null;

    #[ArrayShape([
        'requestUrl' => 'string',
        'requestMethod' => 'string',
        'requestIsAjax' => 'bool',
        'userIp' => 'null|string',
        'responseStatusCode' => 'int',
        'request' => "null|\Psr\Http\Message\ServerRequestInterface",
        'response' => "null|\Psr\Http\Message\ResponseInterface",
    ])]
    public function getCollected(): array
    {
        return [
            'requestUrl' => $this->requestUrl,
            'requestMethod' => $this->requestMethod,
            'requestIsAjax' => $this->requestIsAjax,
            'userIp' => $this->userIp,
            'responseStatusCode' => $this->responseStatusCode,
            'request' => $this->request,
            'response' => $this->response,
        ];
    }

    public function collect(object $event): void
    {
        if (!is_object($event) || !$this->isActive()) {
            return;
        }

        if ($event instanceof BeforeRequest) {
            $this->request = $event->getRequest();
            $this->requestUrl = (string)$event->getRequest()->getUri();
            $this->requestMethod = $event->getRequest()->getMethod();
            $this->requestIsAjax = strtolower(
                $event->getRequest()->getHeaderLine('X-Requested-With') ?? ''
            ) === 'xmlhttprequest';
            $this->userIp = $event->getRequest()->getServerParams()['REMOTE_ADDR'] ?? null;
        }
        if ($event instanceof AfterRequest) {
            $this->response = $event->getResponse();
            $this->responseStatusCode = $event->getResponse() !== null ? $event->getResponse()->getStatusCode() : 500;
        }
    }

    #[ArrayShape([
        'requestUrl' => 'string',
        'requestMethod' => 'string',
        'requestIsAjax' => 'bool',
        'userIp' => 'null|string',
        'responseStatusCode' => 'int',
    ])]
    public function getIndexData(): array
    {
        return [
            'requestUrl' => $this->requestUrl,
            'requestMethod' => $this->requestMethod,
            'requestIsAjax' => $this->requestIsAjax,
            'userIp' => $this->userIp,
            'responseStatusCode' => $this->responseStatusCode,
        ];
    }

    private function reset(): void

The method reset() is not used, and could be removed.

    {
        $this->request = null;
        $this->response = null;
        $this->requestUrl = '';
        $this->requestMethod = '';
        $this->requestIsAjax = false;
        $this->userIp = null;
        $this->responseStatusCode = 200;
    }
}