Civi/Api4/Query/SqlFunctionSUM.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 SqlFunctionSUM extends SqlFunction {
  18
  19   protected static $category = self::CATEGORY_AGGREGATE;
  20
  21   protected static function params(): array {
  22     return [
  23       [
  24         'flag_before' => ['DISTINCT' => ts('Distinct')],
  25         'must_be' => ['SqlField'],
  26       ],
  27     ];
  28   }
  29
  30   /**
  31    * @return string
  32    */
  33   public static function getTitle(): string {
  34     return ts('Sum');
  35   }
  36
  37   /**
  38    * @return string
  39    */
  40   public static function getDescription(): string {
  41     return ts('The sum of all values in the grouping.');
  42   }
  43
  44 }