Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
10 / 10
100.00%
2 / 2
 CRAP
100.00%
1 / 1
IsSubnetOf
100.00%
10 / 10
100.00%
2 / 2
 6
100.00%
1 / 1
 evaluate
100.00%
7 / 7
100.00%
1 / 1
 4
 generateDefaultMessage
100.00%
3 / 3
100.00%
1 / 1
 2
1<?php
2/**
3 * Pop PHP Framework (http://www.popphp.org/)
4 *
5 * @link       https://github.com/popphp/popphp-framework
6 * @author     Nick Sagona, III <dev@noladev.com>
7 * @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
8 * @license    http://www.popphp.org/license     New BSD License
9 */
10
11/**
12 * @namespace
13 */
14namespace Pop\Validator;
15
16/**
17 * Is subnet of validator class
18 *
19 * @category   Pop
20 * @package    Pop\Validator
21 * @author     Nick Sagona, III <dev@noladev.com>
22 * @copyright  Copyright (c) 2009-2025 NOLA Interactive, LLC.
23 * @license    http://www.popphp.org/license     New BSD License
24 * @version    4.5.0
25 */
26class IsSubnetOf extends AbstractValidator
27{
28
29    /**
30     * Method to evaluate the validator
31     *
32     * @param  mixed $input
33     * @throws Exception
34     * @return bool
35     */
36    public function evaluate(mixed $input = null): bool
37    {
38        // Check to make sure the input is a valid Ipv4 address.
39        if (!(new Ipv4())->evaluate($input)) {
40            throw new Exception('The IP address must be a valid IPv4 address.');
41        }
42
43        // Set the input, if passed
44        if ($input !== null) {
45            $this->input = $input;
46        }
47
48        // Set the default message
49        if (!$this->hasMessage()) {
50            $this->generateDefaultMessage();
51        }
52
53        return (substr((string)$this->input, 0, strrpos((string)$this->input, '.')) == $this->value);
54    }
55
56    /**
57     * Generate default message
58
59     * @param  mixed $name
60     * @param  mixed $value
61     * @return string
62     */
63    public function generateDefaultMessage(mixed $name = null, mixed $value = null): string
64    {
65        $this->message = "The " . (($name !== null) ? "'" . $name . "'" : "value") .
66            " must be part of the subnet '" . ($value ?? $this->value) . "'.";
67
68        return $this->message;
69    }
70
71}