Actuator\Health\Status

Complexity

Total Complexity

4

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getCode()	0	4	1
A	getDescription()	0	4	1
A	__toString()	0	4	1

<?php

namespace Actuator\Health;

/**
 * Value object to express state of a component or subsystem.
 *
 * @package Actuator\Health
 */
class Status
{
    /**
     * Value representing unknown state.
     */
    const UNKNOWN = 'UNKNOWN';

    /**
     * Value representing up state.
     */
    const UP = 'UP';

    /**
     * Value representing down state.
     */
    const DOWN = 'DOWN';

    /**
     * Value representing out-of-service state.
     */
    const OUT_OF_SERVICE = 'OUT_OF_SERVICE';

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

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

    /**
     * Create a new Status instance with the given code and description.
     *
     * @param string $code
     * @param string $description
     */
    public function __construct($code, $description = '')
    {
        assert(!is_null($code), 'Code must not be null');

        $this->code = $code;
        $this->description = $description;
    }

    /**
     * Return the code for this status.
     *
     * @return string
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Return the description of this status.
     *
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->code;
    }
}