Civi/Api4/Query/SqlFunctionREPLACE.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 SqlFunctionREPLACE extends SqlFunction {
  18
  19   protected static $category = self::CATEGORY_STRING;
  20
  21   protected static function params(): array {
  22     return [
  23       [
  24         'min_expr' => 3,
  25         'max_expr' => 3,
  26         'optional' => FALSE,
  27         'must_be' => ['SqlString', 'SqlField'],
  28         'ui_defaults' => [
  29           ['type' => 'SqlField', 'placeholder' => ts('Source')],
  30           ['type' => 'SqlString', 'placeholder' => ts('Find')],
  31           ['type' => 'SqlString', 'placeholder' => ts('Replace')],
  32         ],
  33       ],
  34     ];
  35   }
  36
  37   /**
  38    * @return string
  39    */
  40   public static function getTitle(): string {
  41     return ts('Replace text');
  42   }
  43
  44   /**
  45    * @return string
  46    */
  47   public static function getDescription(): string {
  48     return ts('Substitutes one value for another in the text.');
  49   }
  50
  51 }