Helldar\Support\Helpers\Boolean

Complexity

Total Complexity

7

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	to()	0	3	1
A	isTrue()	0	3	1
A	parse()	0	7	2
A	isFalse()	0	3	1
A	convertToString()	0	3	2

<?php
/*
 * This file is part of the "andrey-helldar/support" project.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author Andrey Helldar <helldar@ai-rus.com>
 *
 * @copyright 2021 Andrey Helldar
 *
 * @license MIT
 *
 * @see https://github.com/andrey-helldar/support
 */

namespace Helldar\Support\Helpers;

class Boolean
{
    /**
     * Determines if the value is `true`, otherwise it will return `false`.
     *
     * @param  mixed  $value
     *
     * @return bool
     */
    public function isTrue($value): bool
    {
        return $this->to($value) === true;
    }

    /**
     * Determines if the value is `false`, otherwise it will return `true`.
     *
     * @param  mixed  $value
     *
     * @return bool
     */
    public function isFalse($value): bool
    {
        return $this->to($value) === false;
    }

    /**
     * Converts a value to a boolean type.
     *
     * @param  mixed  $value
     *
     * @return bool
     */
    public function to($value): bool
    {
        return (bool) $this->parse($value);
    }

    /**
     * Getting a filtered value in a boolean view.
     *
     * @param  mixed  $value
     *
     * @return bool|null
     */
    public function parse($value): ?bool
    {
        if (is_null($value)) {
            return null;
        }

        return filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
    }

    /**
     * Converts a boolean value to a string.
     *
     * @param  bool  $value
     *
     * @return string
     */
    public function convertToString(bool $value): string
    {
        return $value ? 'true' : 'false';
    }
}