File: number.inc.php

package info (click to toggle)
zoph 1.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 16,632 kB
  • sloc: php: 28,044; javascript: 10,435; sql: 527; sh: 153; makefile: 4
file content (96 lines) | stat: -rw-r--r-- 2,948 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<?php
/**
 * A confItemNumber defines a configuration item that is defined using a user-specified number
 *
 * This file is part of Zoph.
 *
 * Zoph is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Zoph is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with Zoph; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @package Zoph
 * @author Jeroen Roos
 */

namespace conf\item;

use template\block;

/**
 * A confItemNumber defines a configuration item that is defined using a user-specified number
 *
 * @package Zoph
 * @author Jeroen Roos
 */
class number extends text {

    protected $regex="[0-9]+";
    protected $min=0;
    protected $max=99;
    protected $step=1;

    public function display() : ?block {
        if ($this->internal) {
            return null;
        }
        return new block("confItemNumber", array(
            "label" => e(translate($this->getLabel(), 0)),
            "name" => e($this->getName()),
            "value" => e($this->getValue()),
            "desc" => e(translate($this->getDesc(), 0)),
            "hint" => e(translate($this->getHint(), 0)),
            "regex" => e($this->regex),
            "size" => (int) $this->size,
            "min" => (float) $this->min,
            "max" => (float) $this->max,
            "step" => (float) $this->step,
            "req" => ($this->required ? "required" : "")
        ));
    }

    public function checkValue(string|int $value) : bool {
        if ($this->required && $value=="") {
            return false;
        }

        if ((isset($this->min) && ($value < $this->min)) ||
           (isset($this->max) && ($value > $this->max)) ||
           (isset($this->step) && ($value % $this->step !== 0))) {
            return false;
        } else if (isset($this->regex)) {
            return preg_match("/" . $this->regex ."/", $value);
        } else {
            return true;
        }
    }

    public function setBounds(int $min, int $max, int $step=1) {
        $this->min=$min;
        $this->max=$max;
        $this->step=$step;
    }

    /**
     * Get value of item
     * if value is not set, get default
     * @return bool value
     */
    public function getValue() : ?int {
        if (!isset($this->fields["value"]) || $this->fields["value"]===null || !$this->requirementsMet()) {
            return (int) $this->getDefault();
        } else {
            return (int) $this->fields["value"];
        }
    }


}