Http\HttplugBundle\Collector\ClientDataProvider

Complexity

Total Complexity

18

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	createFromCollectedData()	0	9	2
C	createOne()	0	26	7
A	getRequests()	0	4	1
A	setRequests()	0	6	1
A	getResponses()	0	4	1
A	setResponses()	0	6	1
A	getStackIndexKeys()	0	4	1
A	getRequstStack()	0	4	1
A	getResponseStack()	0	4	1
A	getFailureStack()	0	4	1

<?php

namespace Http\HttplugBundle\Collector;

/**
 * An object to handle the collected data for a client. This is used to display data.
 *
 * The Request object at $requests[0][2] is the state of the object between the third
 * and the fourth plugin. The response after that plugin is found in $responses[0][2].
 *
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
class ClientDataProvider
{
    /**
     * Array that tell if a request errored or not. true = success, false = failure.
     * @var array
     */
    private $failure;

    /**
     * A multidimensional array with requests.
     * $requests[0][0] is the first request before all plugins.
     * $requests[0][1] is the first request after the first plugin.
     *
     * @var array
     */
    private $requests;

    /**
     * A multidimensional array with responses.
     * $responses[0][0] is the first responses before all plugins.
     * $responses[0][1] is the first responses after the first plugin.
     *
     * @var array
     */
    private $responses;

    /**
     * @param array $failure if the response was successful or not
     * @param array $requests
     * @param array $responses
     */
    public function __construct(array $failure, array $requests, array $responses)
    {
        $this->failure = $failure;
        $this->requests = $requests;
        $this->responses = $responses;
    }

    /**
     * Create an array of ClientDataCollector from collected data.
     *
     * @param array $data
     *
     * @return ClientDataProvider[]
     */
    public static function createFromCollectedData(array $data)
    {
        $clientData = [];
        foreach ($data as $clientName => $messages) {
            $clientData[$clientName] = static::createOne($messages);

Since createOne() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of createOne() to at least protected.

        }

        return $clientData;
    }

    /**
     * @param array $messages is an array with keys 'failure', 'request' and 'response' which hold requests for each call to
     *                        sendRequest and for each depth.
     *
     * @return ClientDataProvider
     */
    private static function createOne($messages)
    {
        $orderedFaulure = [];
        $orderedRequests = [];
        $orderedResponses = [];

        foreach ($messages['failure'] as $depth => $failures) {
            foreach ($failures as $idx => $failure) {
                $orderedFaulure[$idx][$depth] = $failure;
            }
        }

        foreach ($messages['request'] as $depth => $requests) {
            foreach ($requests as $idx => $request) {
                $orderedRequests[$idx][$depth] = $request;
            }
        }

        foreach ($messages['response'] as $depth => $responses) {
            foreach ($responses as $idx => $response) {
                $orderedResponses[$idx][$depth] = $response;
            }
        }

        return new self($orderedFaulure, $orderedRequests, $orderedResponses);
    }

    /**
     * @return array
     */
    public function getRequests()
    {
        return $this->requests;
    }

    /**
     * @param array $requests
     *
     * @return ClientDataProvider
     */
    public function setRequests($requests)
    {
        $this->requests = $requests;

        return $this;
    }

    /**
     * @return array
     */
    public function getResponses()
    {
        return $this->responses;
    }

    /**
     * @param array $responses
     *
     * @return ClientDataProvider
     */
    public function setResponses($responses)
    {
        $this->responses = $responses;

        return $this;
    }

    /**
     * Get the index keys for the request and response stacks.
     *
     * @return array
     */
    public function getStackIndexKeys()
    {
        return array_keys($this->requests);
    }

    /**
     * @param int $idx
     *
     * @return array responses
     */
    public function getRequstStack($idx)
    {
        return $this->requests[$idx];
    }

    /**
     * @param int $idx
     *
     * @return array responses
     */
    public function getResponseStack($idx)
    {
        return $this->responses[$idx];
    }

    /**
     * @param int $idx
     *
     * @return array failures
     */
    public function getFailureStack($idx)
    {
        return $this->failure[$idx];
    }
}