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