Context::request() - Code Metrics - zoilomora/elastic-apm-agent-php - Measure and Improve Code Quality continuously with Scrutinizer

Context::request() A
last analyzed 2020-12-16 13:20 UTC

↳ Parent: Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

namespace ZoiloMora\ElasticAPM\Events\Common;

use ZoiloMora\ElasticAPM\Events\Common\Context\Response;

/**
 * Any arbitrary contextual information regarding the event, captured by the agent, optionally provided by the user
 */
class Context implements \JsonSerializable
{
    /**
     * An arbitrary mapping of additional metadata to store with the event.
     *
     * @var array|null
     */
    private $custom;

    /**
     * @var Response|null
     */
    private $response;

    /**
     * If a log record was generated as a result of a http request,
     * the http interface can be used to collect this information.
     *
     * @var Request|null
     */
    private $request;

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

    /**
     * Describes the correlated user for this event.
     * If user data are provided here, all user related information from metadata is ignored,
     * otherwise the metadata's user information will be stored with the event.
     *
     * @var User|null
     */
    private $user;

    /**
     * @var Message|null
     */
    private $message;

    /**
     * @param array|null $custom
     * @param Response|null $response
     * @param Request|null $request
     * @param Tags|null $tags
     * @param User|null $user
     * @param Message|null $message
     */
    public function __construct(
        array $custom = null,
        Response $response = null,
        Request $request = null,
        Tags $tags = null,
        User $user = null,
        Message $message = null
    ) {
        $this->setCustom($custom);
        $this->setResponse($response);
        $this->setRequest($request);
        $this->setTags($tags);
        $this->setUser($user);
        $this->setMessage($message);
    }

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

    /**
     * @param array|null $custom
     *
     * @return void
     */
    public function setCustom(array $custom = null)
    {
        $this->custom = $custom;
    }

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

    /**
     * @param Response|null $response
     *
     * @return void
     */
    public function setResponse(Response $response = null)
    {
        $this->response = $response;
    }

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

    /**
     * @param Request|null $request
     *
     * @return void
     */
    public function setRequest(Request $request = null)
    {
        $this->request = $request;
    }

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

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

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

    /**
     * @param User|null $user
     *
     * @return void
     */
    public function setUser(User $user = null)
    {
        $this->user = $user;
    }

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

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

    /**
     * @return Context
     */
    public static function discover()
    {
        return new self(
            null,
            null,
            Request::discover()
        );
    }

    /**
     * @return array
     */
    public function jsonSerialize()
    {
        return [
            'custom' => $this->custom,
            'response' => $this->response,
            'request' => $this->request,
            'tags' => $this->tags,
            'user' => $this->user,
            'message' => $this->message,
        ];
    }
}


1		<?php
2
3		namespace ZoiloMora\ElasticAPM\Events\Common;
4
5		use ZoiloMora\ElasticAPM\Events\Common\Context\Response;
6
7		/**
8		* Any arbitrary contextual information regarding the event, captured by the agent, optionally provided by the user
9		*/
10		class Context implements \JsonSerializable
11		{
12		/**
13		* An arbitrary mapping of additional metadata to store with the event.
14		*
15		* @var array\|null
16		*/
17		private $custom;
18
19		/**
20		* @var Response\|null
21		*/
22		private $response;
23
24		/**
25		* If a log record was generated as a result of a http request,
26		* the http interface can be used to collect this information.
27		*
28		* @var Request\|null
29		*/
30		private $request;
31
32		/**
33		* A flat mapping of user-defined tags with string, boolean or number values.
34		*
35		* @var Tags\|null
36		*/
37		private $tags;
38
39		/**
40		* Describes the correlated user for this event.
41		* If user data are provided here, all user related information from metadata is ignored,
42		* otherwise the metadata's user information will be stored with the event.
43		*
44		* @var User\|null
45		*/
46		private $user;
47
48		/**
49		* @var Message\|null
50		*/
51		private $message;
52
53		/**
54		* @param array\|null $custom
55		* @param Response\|null $response
56		* @param Request\|null $request
57		* @param Tags\|null $tags
58		* @param User\|null $user
59		* @param Message\|null $message
60		*/
61	15	public function __construct(
62		array $custom = null,
63		Response $response = null,
64		Request $request = null,
65		Tags $tags = null,
66		User $user = null,
67		Message $message = null
68		) {
69	15	$this->setCustom($custom);
70	15	$this->setResponse($response);
71	15	$this->setRequest($request);
72	15	$this->setTags($tags);
73	15	$this->setUser($user);
74	15	$this->setMessage($message);
75	15	}
76
77		/**
78		* @return array\|null
79		*/
80	1	public function custom()
81		{
82	1	return $this->custom;
83		}
84
85		/**
86		* @param array\|null $custom
87		*
88		* @return void
89		*/
90	15	public function setCustom(array $custom = null)
91		{
92	15	$this->custom = $custom;
93	15	}
94
95		/**
96		* @return Response\|null
97		*/
98	1	public function response()
99		{
100	1	return $this->response;
101		}
102
103		/**
104		* @param Response\|null $response
105		*
106		* @return void
107		*/
108	15	public function setResponse(Response $response = null)
109		{
110	15	$this->response = $response;
111	15	}
112
113		/**
114		* @return Request\|null
115		*/
116	1	public function request()
117		{
118	1	return $this->request;
119		}
120
121		/**
122		* @param Request\|null $request
123		*
124		* @return void
125		*/
126	15	public function setRequest(Request $request = null)
127		{
128	15	$this->request = $request;
129	15	}
130
131		/**
132		* @return array\|Tags\|null
133		*/
134	1	public function tags()
135		{
136	1	return $this->tags;
137		}
138
139		/**
140		* @param Tags\|null $tags
141		*
142		* @return void
143		*/
144	15	public function setTags(Tags $tags = null)
145		{
146	15	$this->tags = $tags;
147	15	}
148
149		/**
150		* @return User\|null
151		*/
152	1	public function user()
153		{
154	1	return $this->user;
155		}
156
157		/**
158		* @param User\|null $user
159		*
160		* @return void
161		*/
162	15	public function setUser(User $user = null)
163		{
164	15	$this->user = $user;
165	15	}
166
167		/**
168		* @return Message\|null
169		*/
170	1	public function message()
171		{
172	1	return $this->message;
173		}
174
175		/**
176		* @param Message\|null $message
177		*
178		* @return void
179		*/
180	15	public function setMessage(Message $message = null)
181		{
182	15	$this->message = $message;
183	15	}
184
185		/**
186		* @return Context
187		*/
188	12	public static function discover()
189		{
190	12	return new self(
191	12	null,
192	12	null,
193	12	Request::discover()
194	12	);
195		}
196
197		/**
198		* @return array
199		*/
200	1	public function jsonSerialize()
201		{
202		return [
203	1	'custom' => $this->custom,
204	1	'response' => $this->response,
205	1	'request' => $this->request,
206	1	'tags' => $this->tags,
207	1	'user' => $this->user,
208	1	'message' => $this->message,
209	1	];
210		}
211		}
212

zoilomora / elastic-apm-agent-php

Context::request() A last analyzed 2020-12-16 13:20 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Context::request() A
last analyzed 2020-12-16 13:20 UTC