Status::getStatus() - Code Metrics - apie-lib/status-check-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Status::getStatus() A
last analyzed 2021-02-14 22:32 UTC

↳ Parent: Status

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

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
rs	10

<?php

namespace Apie\StatusCheckPlugin\ApiResources;

use Apie\Core\Annotations\ApiResource;
use Apie\StatusCheckPlugin\DataLayers\StatusCheckRetriever;

/**
 * Creates a status api resource. It's best practice to have an end point to do a health check for your REST API.
 *
 * @ApiResource(
 *     retrieveClass=StatusCheckRetriever::class
 * )
 */
class Status
{
    /**
     * @var string
     */
    private $id;

    /**
     * @var string
     */
    private $status;

    /**
     * @var string|null
     */
    private $optionalReference;

    /**
     * @var array|null
     */
    private $context;

    public function __construct(string $id, string $status = 'OK', ?string $optionalReference = null, ?array $context = null)
    {
        $this->id = $id;
        $this->status = $status;
        $this->optionalReference = $optionalReference;
        $this->context = $context;
    }

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

    /**
     * Returns some status string. The string 'OK' assumes no error was there.
     *
     * @return string
     */
    public function getStatus(): string
    {
        return $this->status;
    }

    /**
     * Return some reference to some arbitrary URL. Useful to link people to a maintenance page with information
     * how long it takes before it's operational again.
     *
     * @return string|null
     */
    public function getOptionalReference(): ?string
    {
        return $this->optionalReference;
    }

    /**
     * Returns an array with arbitrary data. Can be anything....
     *
     * @return array|null
     */
    public function getContext(): ?array
    {
        return $this->context;
    }

    /**
     * Returns true to tell the status check is 'healthy'.
     *
     * @return bool
     */
    public function hasNoErrors(): bool
    {
        return $this->status === 'OK';
    }
}


1			<?php
2
3			namespace Apie\StatusCheckPlugin\ApiResources;
4
5			use Apie\Core\Annotations\ApiResource;
6			use Apie\StatusCheckPlugin\DataLayers\StatusCheckRetriever;
7
8			/**
9			* Creates a status api resource. It's best practice to have an end point to do a health check for your REST API.
10			*
11			* @ApiResource(
12			* retrieveClass=StatusCheckRetriever::class
13			* )
14			*/
15			class Status
16			{
17			/**
18			* @var string
19			*/
20			private $id;
21
22			/**
23			* @var string
24			*/
25			private $status;
26
27			/**
28			* @var string\|null
29			*/
30			private $optionalReference;
31
32			/**
33			* @var array\|null
34			*/
35			private $context;
36
37			public function __construct(string $id, string $status = 'OK', ?string $optionalReference = null, ?array $context = null)
38			{
39			$this->id = $id;
40			$this->status = $status;
41			$this->optionalReference = $optionalReference;
42			$this->context = $context;
43			}
44
45			/**
46			* @return string
47			*/
48			public function getId(): string
49			{
50			return $this->id;
51			}
52
53			/**
54			* Returns some status string. The string 'OK' assumes no error was there.
55			*
56			* @return string
57			*/
58			public function getStatus(): string
59			{
60			return $this->status;
61			}
62
63			/**
64			* Return some reference to some arbitrary URL. Useful to link people to a maintenance page with information
65			* how long it takes before it's operational again.
66			*
67			* @return string\|null
68			*/
69			public function getOptionalReference(): ?string
70			{
71			return $this->optionalReference;
72			}
73
74			/**
75			* Returns an array with arbitrary data. Can be anything....
76			*
77			* @return array\|null
78			*/
79			public function getContext(): ?array
80			{
81			return $this->context;
82			}
83
84			/**
85			* Returns true to tell the status check is 'healthy'.
86			*
87			* @return bool
88			*/
89			public function hasNoErrors(): bool
90			{
91			return $this->status === 'OK';
92			}
93			}
94

apie-lib / status-check-plugin

Status::getStatus() A last analyzed 2021-02-14 22:32 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Status::getStatus() A
last analyzed 2021-02-14 22:32 UTC