| 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 SqlFunctionRAND extends SqlFunction { |
| 18 | |
| 19 | protected static $category = self::CATEGORY_MATH; |
| 20 | |
| 21 | protected static $dataType = 'Float'; |
| 22 | |
| 23 | protected static function params(): array { |
| 24 | return [ |
| 25 | [ |
| 26 | 'optional' => TRUE, |
| 27 | 'must_be' => ['SqlNumber'], |
| 28 | ], |
| 29 | ]; |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * @return string |
| 34 | */ |
| 35 | public static function getTitle(): string { |
| 36 | return ts('Random number'); |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * @return string |
| 41 | */ |
| 42 | public static function getDescription(): string { |
| 43 | return ts('Generates a random number between 0 and 1.'); |
| 44 | } |
| 45 | |
| 46 | } |