Civi/Api4/Query/SqlFunctionCOUNT.php

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