NumberFilter::modulo() - Code Metrics - platine-php/template - Measure and Improve Code Quality continuously with Scrutinizer

NumberFilter::modulo() A
last analyzed 2025-06-24 10:25 UTC

↳ Parent: NumberFilter

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	3
nc	2
nop	2
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php

/**
 * Platine Template
 *
 * Platine Template is a template engine that has taken a lot of inspiration from Django.
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Template
 * Copyright (c) 2014 Guz Alexander, http://guzalexander.com
 * Copyright (c) 2011, 2012 Harald Hanek, http://www.delacap.com
 * Copyright (c) 2006 Mateo Murphy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file NumberFilter.php
 *
 *  The Number Filter class
 *
 *  @package    Platine\Template\Filter
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Template\Filter;

use Platine\Template\Parser\AbstractFilter;

/**
 * @class NumberFilter
 * @package Platine\Template\Filter
 */
class NumberFilter extends AbstractFilter
{
    /**
     * Addition
     * @param float|int $variable
     * @param float|int $operand
     * @return float|int
     */
    public static function plus(float|int $variable, float|int $operand): float|int
    {
        if (is_float($operand) || is_float($variable)) {
            return (float) $variable + (float) $operand;
        }

        return $variable + $operand;
    }

    /**
     * subtraction
     * @param float|int $variable
     * @param float|int $operand
     * @return float|int
     */
    public static function minus(float|int $variable, float|int $operand): float|int
    {
        if (is_float($operand) || is_float($variable)) {
            return (float) $variable - (float) $operand;
        }

        return $variable - $operand;
    }

    /**
     * Times
     * @param float|int $variable
     * @param float|int $operand
     * @return float|int
     */
    public static function times(float|int $variable, float|int $operand): float|int
    {
        if (is_float($operand) || is_float($variable)) {
            return (float) $variable * (float) $operand;
        }

        return $variable * $operand;
    }

    /**
     * Modulo
     * @param float|int $variable
     * @param float|int $operand
     * @return int|float
     */
    public static function modulo(float|int $variable, float|int $operand): float|int
    {
        if (is_float($operand) || is_float($variable)) {
            return fmod((float) $variable, (float) $operand);
        }

        return fmod($variable, $operand);
    }

    /**
     * Division filter
     * @param float|int $variable
     * @param float|int $operand
     * @return int|float
     */
    public static function div(float|int $variable, float|int $operand): float|int
    {
        if ($operand == 0) {// don't use ===
            return $variable;
        }

        if (is_float($operand) || is_float($variable)) {
            return (float) ($variable / $operand);
        }

        return ($variable / $operand);
    }

    /**
     * Round the number
     * @param float|int $variable
     * @param int $number
     * @return float
     */
    public static function round(float|int $variable, int $number = 0): float
    {
        return round((float) $variable, (int) $number);
    }

    /**
     * Number format
     * @param float|int|string|null $variable
     * @param int|string $decimal
     * @param string $decimalPoint
     * @param string $separator
     * @return string
     */
    public static function format(
        float|int|string|null $variable,
        int|string $decimal = 0,
        string $decimalPoint = '.',
        string $separator = ','
    ): string {
        if (is_string($variable) && is_numeric($variable) === false) {
            return $variable;
        }

        return number_format(
            (float) $variable,
            (int) $decimal,
            $decimalPoint,
            $separator
        );
    }

    /**
     * Number format for money
     * @param float|int|string|null $variable
     * @param string|int $decimal
     * @param string $decimalPoint
     * @param string $separator
     * @return string
     */
    public static function formatMoney(
        float|int|string|null $variable,
        int|string $decimal = 0,
        string $decimalPoint = '.',
        string $separator = ','
    ): string {
        if (is_string($variable) && is_numeric($variable) === false) {
            return $variable;
        }

        $number = (string) $variable;
        if (strpos($number, '.') === false && strpos($number, ',') === false) {
            $decimal = 0;
        }

        return number_format(
            (float) $variable,
            (int) $decimal,
            $decimalPoint,
            $separator
        );
    }

    /**
     * Return the given number to string
     * @param float|int|string|null $variable
     * @return string
     */
    public static function numberToString(float|int|string|null $variable): string
    {
        $value = (string) $variable;
        if (stripos($value, 'e') !== false) {
            // PHP use scientific notation if decimal has 4 zeros
            // after dot. so use number format instead of
            list($base, $decimal) = explode('E', $value);

            // Some system use "," instead of "."
            if (strpos($value, ',') !== false) {
                $arr = explode(',', $base);
            } else {
                $arr = explode('.', $base);
            }
            $separator = '%.' . (string)(strlen($arr[1]) + (abs((int)$decimal) - 1)) . 'f';

            $value = sprintf($separator, $variable);
        }

        return str_replace(',', '.', $value);
    }

    /**
     * Units format
     * @param float|int|string|null $variable
     * @param int|string $precision
     * @return float|int|string|null
     */
    public static function sizeFormat(
        float|int|string|null $variable,
        int|string $precision = 2
    ): float|int|string|null {
        if (is_string($variable) && is_numeric($variable) === false) {
            return $variable;
        }

        $size = (double) $variable;
        if ($size > 0) {
            $base = log($size) / log(1024);
            $suffixes = ['B', 'K', 'M', 'G', 'T'];
            $suffix = '';
            if (isset($suffixes[floor($base)])) {
                $suffix = $suffixes[floor($base)];
            }
            return round(pow(1024, $base - floor($base)), (int) $precision) . $suffix;
        }

        return $variable;
    }
}


1			<?php
2
3			/**
4			* Platine Template
5			*
6			* Platine Template is a template engine that has taken a lot of inspiration from Django.
7			*
8			* This content is released under the MIT License (MIT)
9			*
10			* Copyright (c) 2020 Platine Template
11			* Copyright (c) 2014 Guz Alexander, http://guzalexander.com
12			* Copyright (c) 2011, 2012 Harald Hanek, http://www.delacap.com
13			* Copyright (c) 2006 Mateo Murphy
14			*
15			* Permission is hereby granted, free of charge, to any person obtaining a copy
16			* of this software and associated documentation files (the "Software"), to deal
17			* in the Software without restriction, including without limitation the rights
18			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19			* copies of the Software, and to permit persons to whom the Software is
20			* furnished to do so, subject to the following conditions:
21			*
22			* The above copyright notice and this permission notice shall be included in all
23			* copies or substantial portions of the Software.
24			*
25			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31			* SOFTWARE.
32			*/
33
34			/**
35			* @file NumberFilter.php
36			*
37			* The Number Filter class
38			*
39			* @package Platine\Template\Filter
40			* @author Platine Developers Team
41			* @copyright Copyright (c) 2020
42			* @license http://opensource.org/licenses/MIT MIT License
43			* @link https://www.platine-php.com
44			* @version 1.0.0
45			* @filesource
46			*/
47
48			declare(strict_types=1);
49
50			namespace Platine\Template\Filter;
51
52			use Platine\Template\Parser\AbstractFilter;
53
54			/**
55			* @class NumberFilter
56			* @package Platine\Template\Filter
57			*/
58			class NumberFilter extends AbstractFilter
59			{
60			/**
61			* Addition
62			* @param float\|int $variable
63			* @param float\|int $operand
64			* @return float\|int
65			*/
66			public static function plus(float\|int $variable, float\|int $operand): float\|int
67			{
68			if (is_float($operand) \|\| is_float($variable)) {
69			return (float) $variable + (float) $operand;
70			}
71
72			return $variable + $operand;
73			}
74
75			/**
76			* subtraction
77			* @param float\|int $variable
78			* @param float\|int $operand
79			* @return float\|int
80			*/
81			public static function minus(float\|int $variable, float\|int $operand): float\|int
82			{
83			if (is_float($operand) \|\| is_float($variable)) {
84			return (float) $variable - (float) $operand;
85			}
86
87			return $variable - $operand;
88			}
89
90			/**
91			* Times
92			* @param float\|int $variable
93			* @param float\|int $operand
94			* @return float\|int
95			*/
96			public static function times(float\|int $variable, float\|int $operand): float\|int
97			{
98			if (is_float($operand) \|\| is_float($variable)) {
99			return (float) $variable * (float) $operand;
100			}
101
102			return $variable * $operand;
103			}
104
105			/**
106			* Modulo
107			* @param float\|int $variable
108			* @param float\|int $operand
109			* @return int\|float
110			*/
111			public static function modulo(float\|int $variable, float\|int $operand): float\|int
112			{
113			if (is_float($operand) \|\| is_float($variable)) {
114			return fmod((float) $variable, (float) $operand);
115			}
116
117			return fmod($variable, $operand);
118			}
119
120			/**
121			* Division filter
122			* @param float\|int $variable
123			* @param float\|int $operand
124			* @return int\|float
125			*/
126			public static function div(float\|int $variable, float\|int $operand): float\|int
127			{
128			if ($operand == 0) {// don't use ===
129			return $variable;
130			}
131
132			if (is_float($operand) \|\| is_float($variable)) {
133			return (float) ($variable / $operand);
134			}
135
136			return ($variable / $operand);
137			}
138
139			/**
140			* Round the number
141			* @param float\|int $variable
142			* @param int $number
143			* @return float
144			*/
145			public static function round(float\|int $variable, int $number = 0): float
146			{
147			return round((float) $variable, (int) $number);
148			}
149
150			/**
151			* Number format
152			* @param float\|int\|string\|null $variable
153			* @param int\|string $decimal
154			* @param string $decimalPoint
155			* @param string $separator
156			* @return string
157			*/
158			public static function format(
159			float\|int\|string\|null $variable,
160			int\|string $decimal = 0,
161			string $decimalPoint = '.',
162			string $separator = ','
163			): string {
164			if (is_string($variable) && is_numeric($variable) === false) {
165			return $variable;
166			}
167
168			return number_format(
169			(float) $variable,
170			(int) $decimal,
171			$decimalPoint,
172			$separator
173			);
174			}
175
176			/**
177			* Number format for money
178			* @param float\|int\|string\|null $variable
179			* @param string\|int $decimal
180			* @param string $decimalPoint
181			* @param string $separator
182			* @return string
183			*/
184			public static function formatMoney(
185			float\|int\|string\|null $variable,
186			int\|string $decimal = 0,
187			string $decimalPoint = '.',
188			string $separator = ','
189			): string {
190			if (is_string($variable) && is_numeric($variable) === false) {
191			return $variable;
192			}
193
194			$number = (string) $variable;
195			if (strpos($number, '.') === false && strpos($number, ',') === false) {
196			$decimal = 0;
197			}
198
199			return number_format(
200			(float) $variable,
201			(int) $decimal,
202			$decimalPoint,
203			$separator
204			);
205			}
206
207			/**
208			* Return the given number to string
209			* @param float\|int\|string\|null $variable
210			* @return string
211			*/
212			public static function numberToString(float\|int\|string\|null $variable): string
213			{
214			$value = (string) $variable;
215			if (stripos($value, 'e') !== false) {
216			// PHP use scientific notation if decimal has 4 zeros
217			// after dot. so use number format instead of
218			list($base, $decimal) = explode('E', $value);
219
220			// Some system use "," instead of "."
221			if (strpos($value, ',') !== false) {
222			$arr = explode(',', $base);
223			} else {
224			$arr = explode('.', $base);
225			}
226			$separator = '%.' . (string)(strlen($arr[1]) + (abs((int)$decimal) - 1)) . 'f';
227
228			$value = sprintf($separator, $variable);
229			}
230
231			return str_replace(',', '.', $value);
232			}
233
234			/**
235			* Units format
236			* @param float\|int\|string\|null $variable
237			* @param int\|string $precision
238			* @return float\|int\|string\|null
239			*/
240			public static function sizeFormat(
241			float\|int\|string\|null $variable,
242			int\|string $precision = 2
243			): float\|int\|string\|null {
244			if (is_string($variable) && is_numeric($variable) === false) {
245			return $variable;
246			}
247
248			$size = (double) $variable;
249			if ($size > 0) {
250			$base = log($size) / log(1024);
251			$suffixes = ['B', 'K', 'M', 'G', 'T'];
252			$suffix = '';
253			if (isset($suffixes[floor($base)])) {
254			$suffix = $suffixes[floor($base)];
255			}
256			return round(pow(1024, $base - floor($base)), (int) $precision) . $suffix;
257			}
258
259			return $variable;
260			}
261			}
262

platine-php / template

NumberFilter::modulo() A last analyzed 2025-06-24 10:25 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

NumberFilter::modulo() A
last analyzed 2025-06-24 10:25 UTC