Civi/Api4/Query/SqlFunctionLOWER.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 SqlFunctionLOWER extends SqlFunction {
  18
  19   protected static $dataType = 'String';
  20
  21   protected static $category = self::CATEGORY_STRING;
  22
  23   protected static function params(): array {
  24     return [
  25       [
  26         'optional' => FALSE,
  27         'must_be' => ['SqlField', 'SqlString'],
  28       ],
  29     ];
  30   }
  31
  32   /**
  33    * @return string
  34    */
  35   public static function getTitle(): string {
  36     return ts('Lowercase');
  37   }
  38
  39   /**
  40    * @return string
  41    */
  42   public static function getDescription(): string {
  43     return ts('Lowercase version of text.');
  44   }
  45
  46 }