TxTextControl\ReportingCloud\Assert\AssertZoomFactorTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Test Coverage

Coverage

88.89%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	assertZoomFactor()	0	12	2

<?php
declare(strict_types=1);

namespace TxTextControl\ReportingCloud\Assert;

/**
 * ReportingCloud PHP Wrapper
 *
 * PHP wrapper for ReportingCloud Web API. Authored and supported by Text Control GmbH.
 *
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
 * @license   https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
 * @copyright © 2019 Text Control GmbH
 */

/**
 * Trait AssertZoomFactorTrait
 *
 * @package TxTextControl\ReportingCloud
 * @author  Jonathan Maron (@JonathanMaron)
 */
trait AssertZoomFactorTrait
{
    /**
     * Minimum zoom factor
     *
     * @var int
     */
    private static $zoomFactorMin = 1;

    /**
     * Maximum zoom factor
     *
     * @var int
     */
    private static $zoomFactorMax = 400;

    /**
     * Validate zoom factor
     *
     * @param int    $value
     * @param string $message
     *
     * @return null
     * @throws \TxTextControl\ReportingCloud\Exception\InvalidArgumentException
     */
    public static function assertZoomFactor(int $value, string $message = '')
    {
        $format  = 'Zoom factor (%s) must be in the range [%2$s..%3$s]';
        $message = sprintf(
            $message ?:
            $format,
            self::valueToString($value),
            self::valueToString(self::$zoomFactorMin),
            self::valueToString(self::$zoomFactorMax)
        );

        return self::range($value, self::$zoomFactorMin, self::$zoomFactorMax, $message);
    }
}