icingadb-web/library/Icingadb/Common/HostStates.php

<?php

// SPDX-FileCopyrightText: 2019 Icinga GmbH <https://icinga.com>
// SPDX-License-Identifier: GPL-3.0-or-later

namespace Icinga\Module\Icingadb\Common;

/**
 * Collection of possible host states.
 */
class HostStates
{
    public const UP = 0;

    public const DOWN = 1;

    public const PENDING = 99;

    /**
     * Get the integer value of the given textual host state
     *
     * @param string $state
     *
     * @return int
     *
     * @throws \InvalidArgumentException If the given host state is invalid, i.e. not known
     */
    public static function int(string $state): int
    {
        switch (strtolower($state)) {
            case 'up':
                $int = self::UP;
                break;
            case 'down':
                $int = self::DOWN;
                break;
            case 'pending':
                $int = self::PENDING;
                break;
            default:
                throw new \InvalidArgumentException(sprintf('Invalid host state %d', $state));
        }

        return $int;
    }

    /**
     * Get the textual representation of the passed host state
     *
     * @param ?int $state
     *
     * @return string
     *
     * @throws \InvalidArgumentException If the given host state is invalid, i.e. not known
     */
    public static function text(?int $state = null): string
    {
        switch (true) {
            case $state === self::UP:
                $text = 'up';
                break;
            case $state === self::DOWN:
                $text = 'down';
                break;
            case $state === self::PENDING:
                $text = 'pending';
                break;
            case $state === null:
                $text = 'not-available';
                break;
            default:
                throw new \InvalidArgumentException(sprintf('Invalid host state %d', $state));
        }

        return $text;
    }

    /**
     * Get the translated textual representation of the passed host state
     *
     * @param ?int $state
     *
     * @return string
     *
     * @throws \InvalidArgumentException If the given host state is invalid, i.e. not known
     */
    public static function translated(?int $state = null): string
    {
        switch (true) {
            case $state === self::UP:
                $text = t('up');
                break;
            case $state === self::DOWN:
                $text = t('down');
                break;
            case $state === self::PENDING:
                $text = t('pending');
                break;
            case $state === null:
                $text = t('not available');
                break;
            default:
                throw new \InvalidArgumentException(sprintf('Invalid host state %d', $state));
        }

        return $text;
    }
}