ZoiloMora\ElasticAPM\Events\Span\Context

Complexity

Total Complexity

15

Size/Duplication

Total Lines	181
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	destination()	0	3	1
A	fromDb()	0	3	1
A	fromMessage()	0	3	1
A	fromHttp()	0	3	1
A	__construct()	0	12	1
A	db()	0	3	1
A	jsonSerialize()	0	8	1
A	setTags()	0	3	1
A	setHttp()	0	3	1
A	setMessage()	0	3	1
A	http()	0	3	1
A	setDestination()	0	3	1
A	message()	0	3	1
A	tags()	0	3	1
A	setDb()	0	3	1

<?php

namespace ZoiloMora\ElasticAPM\Events\Span;

use ZoiloMora\ElasticAPM\Events\Common\Message;
use ZoiloMora\ElasticAPM\Events\Common\Tags;
use ZoiloMora\ElasticAPM\Events\Span\Context\Db;
use ZoiloMora\ElasticAPM\Events\Span\Context\Destination;
use ZoiloMora\ElasticAPM\Events\Span\Context\Http;

/**
 * Any other arbitrary data captured by the agent, optionally provided by the user
 */
final class Context implements \JsonSerializable
{
    /**
     * An object containing contextual data about the destination for spans
     *
     * @var Destination|null
     */
    private $destination;

    /**
     * An object containing contextual data for database spans
     *
     * @var Db|null
     */
    private $db;

    /**
     * An object containing contextual data of the related http request.
     *
     * @var Http|null
     */
    private $http;

    /**
     * A flat mapping of user-defined tags with string, boolean or number values.
     * "string", "boolean", "number", "null"
     *
     * @var Tags|null
     */
    private $tags;

    /**
     * Details related to message receiving and publishing if the captured event
     * integrates with a messaging system
     *
     * @var Message|null
     */
    private $message;

    /**
     * @param Destination|null $destination
     * @param Db|null $db
     * @param Http|null $http
     * @param Tags|null $tags
     * @param Message|null $message
     */
    public function __construct(
        Destination $destination = null,
        Db $db = null,
        Http $http = null,
        Tags $tags = null,
        Message $message = null
    ) {
        $this->setDestination($destination);
        $this->setDb($db);
        $this->setHttp($http);
        $this->setTags($tags);
        $this->setMessage($message);
    }

    /**
     * @param Db $db
     *
     * @return Context
     */
    public static function fromDb(Db $db)
    {
        return new self(null, $db);
    }

    /**
     * @param Http $http
     *
     * @return Context
     */
    public static function fromHttp(Http $http)
    {
        return new self(null, null, $http);
    }

    /**
     * @param Message $message
     *
     * @return Context
     */
    public static function fromMessage(Message $message)
    {
        return new self(null, null, null, null, $message);
    }

    /**
     * @return Destination|null
     */
    public function destination()
    {
        return $this->destination;
    }

    /**
     * @param Destination|null $destination
     */
    public function setDestination(Destination $destination = null)
    {
        $this->destination = $destination;
    }

    /**
     * @return Db|null
     */
    public function db()
    {
        return $this->db;
    }

    /**
     * @param Db|null $db
     */
    public function setDb(Db $db = null)
    {
        $this->db = $db;
    }

    /**
     * @return Http|null
     */
    public function http()
    {
        return $this->http;
    }

    /**
     * @param Http|null $http
     */
    public function setHttp(Http $http = null)
    {
        $this->http = $http;
    }

    /**
     * @return Tags|null
     */
    public function tags()
    {
        return $this->tags;
    }

    /**
     * @param Tags|null $tags
     */
    public function setTags(Tags $tags = null)
    {
        $this->tags = $tags;
    }

    /**
     * @return Message|null
     */
    public function message()
    {
        return $this->message;
    }

    /**
     * @param Message|null $message
     */
    public function setMessage(Message $message = null)
    {
        $this->message = $message;
    }

    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'destination' => $this->destination,
            'db' => $this->db,
            'http' => $this->http,
            'tags' => $this->tags,
            'message' => $this->message,
        ];
    }
}