Commit | Line | Data |
---|---|---|
f0acec37 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 SqlFunctionAVG extends SqlFunction { | |
18 | ||
e7f6def6 CW |
19 | protected static $category = self::CATEGORY_AGGREGATE; |
20 | ||
d3be4a16 CW |
21 | protected static $dataType = 'Float'; |
22 | ||
f19a0f00 CW |
23 | protected static function params(): array { |
24 | return [ | |
25 | [ | |
1b6a82ee | 26 | 'flag_before' => ['DISTINCT' => ts('Distinct')], |
f19a0f00 CW |
27 | 'must_be' => ['SqlField'], |
28 | ], | |
29 | ]; | |
30 | } | |
f0acec37 | 31 | |
9cae8a07 CW |
32 | /** |
33 | * @return string | |
34 | */ | |
35 | public static function getTitle(): string { | |
36 | return ts('Average'); | |
37 | } | |
38 | ||
1fe4682d CW |
39 | /** |
40 | * @return string | |
41 | */ | |
42 | public static function getDescription(): string { | |
43 | return ts('The mean of all values in the grouping.'); | |
44 | } | |
45 | ||
f0acec37 | 46 | } |