Commit | Line | Data |
---|---|---|
e7f6def6 CW |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | Copyright CiviCRM LLC. All rights reserved. | | |
5 | | | | |
6 | | This work is published under the GNU AGPLv3 license with some | | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
9 | +--------------------------------------------------------------------+ | |
10 | */ | |
11 | ||
12 | namespace Civi\Api4\Query; | |
13 | ||
14 | /** | |
15 | * Sql function | |
16 | */ | |
17 | class SqlFunctionROUND extends SqlFunction { | |
18 | ||
19 | protected static $category = self::CATEGORY_MATH; | |
20 | ||
d3be4a16 CW |
21 | protected static $dataType = 'Float'; |
22 | ||
f19a0f00 CW |
23 | protected static function params(): array { |
24 | return [ | |
25 | [ | |
26 | 'optional' => FALSE, | |
9e9feedf CW |
27 | 'must_be' => ['SqlField', 'SqlNumber'], |
28 | 'label' => ts('Number'), | |
29 | ], | |
30 | [ | |
31 | 'optional' => TRUE, | |
32 | 'must_be' => ['SqlNumber'], | |
33 | 'label' => ts('Decimal places'), | |
f19a0f00 CW |
34 | ], |
35 | ]; | |
36 | } | |
e7f6def6 | 37 | |
9cae8a07 CW |
38 | /** |
39 | * @return string | |
40 | */ | |
41 | public static function getTitle(): string { | |
42 | return ts('Round'); | |
43 | } | |
44 | ||
1fe4682d CW |
45 | /** |
46 | * @return string | |
47 | */ | |
48 | public static function getDescription(): string { | |
49 | return ts('Number rounded to specified number of decimal places.'); | |
50 | } | |
51 | ||
e7f6def6 | 52 | } |