Payload::setChannel() - Code Metrics - Inspection of "track additional info" - logfileco/logfile-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8f026b...0fb977 )

by Waaaaaaaaaa

created 2019-05-03 11:26 UTC

Payload::setChannel() A

↳ Parent: Payload

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);

namespace Logfile;

use Throwable;

class Payload
{
    protected $message;

    protected $config;

    protected $id;

    protected $context;

    protected $extra = [];

    public function __construct(string $message, Config $config)
    {
        $this->message = $message;
        $this->config = $config;
        $this->id = $this->uuid4();
    }

    public function getMessage(): string
    {
        return $this->message;
    }

    public function setExtra(string $key, $value): void
    {
        $this->extra[$key] = $value;
    }

    public function setContext(array $context): void
    {
        $this->context = $context;
    }

    public function hasContext(): bool
    {
        return !empty($this->context);
    }

    public function getContext(): array
    {
        return $this->context;
    }

    public static function createFromException(Throwable $exception, Config $config): self
    {
        $payload = new Payload($exception->getMessage(), $config);
        $trace = new Stacktrace($exception);
        $trace->setPath($config->getPath());
        $context = $trace->getFrames();
        $payload->setContext($context);
        return $payload;
    }

    public function setId(string $id): void
    {
        $this->id = $id;
    }

    public function getId(): string
    {
        return $this->id;
    }

    public function setChannel(string $channel): void
    {
        $this->channel = $channel;

    }

    /**
     * Get payload data
     *
     * @return array
     */
    public function getData(): array
    {
        $extra = array_merge($this->extra, [
            'id' => $this->getId(),
        ]);

        if ($this->config->hasTags()) {
            $extra['tags'] = $this->config->getTags();
        }

        if ($this->config->hasUser()) {
            $extra['user'] = $this->config->getUser();
        }

        if ($this->config->hasRelease()) {
            $extra['release'] = $this->config->getRelease();
        }

        $data = [
            'message' => $this->getMessage(),
            'extra' => $extra,
        ];

        if ($this->hasContext()) {
            $data['context'] = $this->getContext();
        }

        return $data;
    }

    /**
     * Get payload json encoded
     *
     * @return string
     */
    public function getEncodedData(): string
    {
        $data = $this->getData();
        $encoded = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

        if (JSON_ERROR_UTF8 === json_last_error()) {
            if (is_string($data)) {

                $this->detectAndCleanUtf8($data);
            } elseif (is_array($data)) {

                array_walk_recursive($data, array($this, 'detectAndCleanUtf8'));
            }
            $encoded = json_encode($data, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
        }

        if (JSON_ERROR_NONE !== json_last_error()) {
            $error = json_last_error_msg();
            throw new \LogicException(sprintf('Failed to encode json data: %s.', $error));
        }

        return $encoded;
    }

    /**
     * Detect invalid UTF-8 string characters and convert to valid UTF-8.
     * @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/NormalizerFormatter.php
     */
    public function detectAndCleanUtf8(&$data)
    {
        if (is_string($data) && !preg_match('//u', $data)) {
            $data = preg_replace_callback(
                '/[\x80-\xFF]+/',
                function ($m) {
                    return utf8_encode($m[0]);
                },
                $data
            );
            $data = str_replace(
                array('¤', '¦', '¨', '´', '¸', '¼', '½', '¾'),
                array('€', 'Š', 'š', 'Ž', 'ž', 'Œ', 'œ', 'Ÿ'),
                $data
            );
        }
    }

    /**
     * Get uuid v4
     *
     * @see http://www.php.net/manual/en/function.uniqid.php#94959
     * @return string
     */
    protected function uuid4(): string
    {
        mt_srand();
        return sprintf(
            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
            // 32 bits for "time_low"
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff),
            // 16 bits for "time_mid"
            mt_rand(0, 0xffff),
            // 16 bits for "time_hi_and_version",
            // four most significant bits holds version number 4
            mt_rand(0, 0x0fff) | 0x4000,
            // 16 bits, 8 bits for "clk_seq_hi_res",
            // 8 bits for "clk_seq_low",
            // two most significant bits holds zero and one for variant DCE1.1
            mt_rand(0, 0x3fff) | 0x8000,
            // 48 bits for "node"
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff),
            mt_rand(0, 0xffff)
        );
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Logfile;
4
5			use Throwable;
6
7			class Payload
8			{
9			protected $message;
10
11			protected $config;
12
13			protected $id;
14
15			protected $context;
16
17			protected $extra = [];
18
19			public function __construct(string $message, Config $config)
20			{
21			$this->message = $message;
22			$this->config = $config;
23			$this->id = $this->uuid4();
24			}
25
26			public function getMessage(): string
27			{
28			return $this->message;
29			}
30
31			public function setExtra(string $key, $value): void
32			{
33			$this->extra[$key] = $value;
34			}
35
36			public function setContext(array $context): void
37			{
38			$this->context = $context;
39			}
40
41			public function hasContext(): bool
42			{
43			return !empty($this->context);
44			}
45
46			public function getContext(): array
47			{
48			return $this->context;
49			}
50
51			public static function createFromException(Throwable $exception, Config $config): self
52			{
53			$payload = new Payload($exception->getMessage(), $config);
54			$trace = new Stacktrace($exception);
55			$trace->setPath($config->getPath());
56			$context = $trace->getFrames();
57			$payload->setContext($context);
58			return $payload;
59			}
60
61			public function setId(string $id): void
62			{
63			$this->id = $id;
64			}
65
66			public function getId(): string
67			{
68			return $this->id;
69			}
70
71			public function setChannel(string $channel): void
72			{
73			$this->channel = $channel;
			0 ignored issues – show Bug Best Practice introduced 2019-05-03 11:29 UTC by Report Bug Copy Issue Report The property `channel` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
74			}
75
76			/**
77			* Get payload data
78			*
79			* @return array
80			*/
81			public function getData(): array
82			{
83			$extra = array_merge($this->extra, [
84			'id' => $this->getId(),
85			]);
86
87			if ($this->config->hasTags()) {
88			$extra['tags'] = $this->config->getTags();
89			}
90
91			if ($this->config->hasUser()) {
92			$extra['user'] = $this->config->getUser();
93			}
94
95			if ($this->config->hasRelease()) {
96			$extra['release'] = $this->config->getRelease();
97			}
98
99			$data = [
100			'message' => $this->getMessage(),
101			'extra' => $extra,
102			];
103
104			if ($this->hasContext()) {
105			$data['context'] = $this->getContext();
106			}
107
108			return $data;
109			}
110
111			/**
112			* Get payload json encoded
113			*
114			* @return string
115			*/
116			public function getEncodedData(): string
117			{
118			$data = $this->getData();
119			$encoded = json_encode($data, JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE);
120
121			if (JSON_ERROR_UTF8 === json_last_error()) {
122			if (is_string($data)) {
			0 ignored issues – show introduced 2019-05-02 15:39 UTC by Report Bug Copy Issue Report The condition `is_string($data)` is always `false`. Loading history...
123			$this->detectAndCleanUtf8($data);
124			} elseif (is_array($data)) {
			0 ignored issues – show introduced 2019-05-02 15:39 UTC by Report Bug Copy Issue Report The condition `is_array($data)` is always `true`. Loading history...
125			array_walk_recursive($data, array($this, 'detectAndCleanUtf8'));
126			}
127			$encoded = json_encode($data, JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE);
128			}
129
130			if (JSON_ERROR_NONE !== json_last_error()) {
131			$error = json_last_error_msg();
132			throw new \LogicException(sprintf('Failed to encode json data: %s.', $error));
133			}
134
135			return $encoded;
136			}
137
138			/**
139			* Detect invalid UTF-8 string characters and convert to valid UTF-8.
140			* @see https://github.com/Seldaek/monolog/blob/master/src/Monolog/Formatter/NormalizerFormatter.php
141			*/
142			public function detectAndCleanUtf8(&$data)
143			{
144			if (is_string($data) && !preg_match('//u', $data)) {
145			$data = preg_replace_callback(
146			'/[\x80-\xFF]+/',
147			function ($m) {
148			return utf8_encode($m[0]);
149			},
150			$data
151			);
152			$data = str_replace(
153			array('¤', '¦', '¨', '´', '¸', '¼', '½', '¾'),
154			array('€', 'Š', 'š', 'Ž', 'ž', 'Œ', 'œ', 'Ÿ'),
155			$data
156			);
157			}
158			}
159
160			/**
161			* Get uuid v4
162			*
163			* @see http://www.php.net/manual/en/function.uniqid.php#94959
164			* @return string
165			*/
166			protected function uuid4(): string
167			{
168			mt_srand();
169			return sprintf(
170			'%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
171			// 32 bits for "time_low"
172			mt_rand(0, 0xffff),
173			mt_rand(0, 0xffff),
174			// 16 bits for "time_mid"
175			mt_rand(0, 0xffff),
176			// 16 bits for "time_hi_and_version",
177			// four most significant bits holds version number 4
178			mt_rand(0, 0x0fff) \| 0x4000,
179			// 16 bits, 8 bits for "clk_seq_hi_res",
180			// 8 bits for "clk_seq_low",
181			// two most significant bits holds zero and one for variant DCE1.1
182			mt_rand(0, 0x3fff) \| 0x8000,
183			// 48 bits for "node"
184			mt_rand(0, 0xffff),
185			mt_rand(0, 0xffff),
186			mt_rand(0, 0xffff)
187			);
188			}
189			}
190

logfileco / logfile-php

Push — master ( 8f026b...0fb977 )

Payload::setChannel() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like