Passed
Branch development-2.0 (469a91)
by Jonathan
04:44
created

AssertPageTrait::assertPage()   A

Complexity

Conditions 2
Paths 1

Size

Total Lines 12
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 2.0054

Importance

Changes 0
Metric Value
eloc 8
dl 0
loc 12
ccs 8
cts 9
cp 0.8889
rs 10
c 0
b 0
f 0
cc 2
nc 1
nop 2
crap 2.0054
1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * ReportingCloud PHP Wrapper
6
 *
7
 * PHP wrapper for ReportingCloud Web API. Authored and supported by Text Control GmbH.
8
 *
9
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
10
 * @link      https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
11
 * @license   https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
12
 * @copyright © 2019 Text Control GmbH
13
 */
14
15
namespace TxTextControl\ReportingCloud\Assert;
16
17
/**
18
 * Trait AssertPageTrait
19
 *
20
 * @package TxTextControl\ReportingCloud
21
 * @author  Jonathan Maron (@JonathanMaron)
22
 */
23
trait AssertPageTrait
24
{
25
    /**
26
     * Minimum page number
27
     *
28
     * @var int
29
     */
30
    private static $pageMin = 1;
31
32
    /**
33
     * Maximum page number
34
     *
35
     * @var int
36
     */
37
    private static $pageMax = PHP_INT_MAX;
38
39
    /**
40
     * Validate page
41
     *
42
     * @param int    $value
43
     * @param string $message
44
     *
45
     * @return null
46
     * @throws \TxTextControl\ReportingCloud\Exception\InvalidArgumentException
47
     */
48 7
    public static function assertPage(int $value, string $message = '')
49
    {
50 7
        $format  = 'Page number (%s) must be in the range [%2$s..%3$s]';
51 7
        $message = sprintf(
52
            $message ?:
53 7
            $format,
54 7
            self::valueToString($value),
55 7
            self::valueToString(self::$pageMin),
56 7
            self::valueToString(self::$pageMax)
57
        );
58
59 7
        return self::range($value, self::$pageMin, self::$pageMax, $message);
60
    }
61
}
62