Apie\StatusCheckPlugin\ApiResources\Status

Complexity

Total Complexity

6

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getStatus()	0	3	1
A	hasNoErrors()	0	3	1
A	getContext()	0	3	1
A	getId()	0	3	1
A	__construct()	0	6	1
A	getOptionalReference()	0	3	1

<?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';
    }
}