Civi/Api4/Query/SqlFunctionROUND.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 SqlFunctionROUND extends SqlFunction {
  18
  19   protected static $category = self::CATEGORY_MATH;
  20
  21   protected static function params(): array {
  22     return [
  23       [
  24         'optional' => FALSE,
  25         'must_be' => ['SqlField', 'SqlNumber'],
  26         'label' => ts('Number'),
  27       ],
  28       [
  29         'optional' => TRUE,
  30         'must_be' => ['SqlNumber'],
  31         'label' => ts('Decimal places'),
  32       ],
  33     ];
  34   }
  35
  36   /**
  37    * @return string
  38    */
  39   public static function getTitle(): string {
  40     return ts('Round');
  41   }
  42
  43   /**
  44    * @return string
  45    */
  46   public static function getDescription(): string {
  47     return ts('Number rounded to specified number of decimal places.');
  48   }
  49
  50 }