Civi/Api4/Query/SqlFunctionGROUP_CONCAT.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 SqlFunctionGROUP_CONCAT extends SqlFunction {
  18
  19   protected static $category = self::CATEGORY_AGGREGATE;
  20
  21   protected static $params = [
  22     [
  23       'prefix' => ['', 'DISTINCT', 'ALL'],
  24       'expr' => 1,
  25       'must_be' => ['SqlField'],
  26       'optional' => FALSE,
  27     ],
  28     [
  29       'prefix' => ['ORDER BY'],
  30       'expr' => 1,
  31       'suffix' => ['', 'ASC', 'DESC'],
  32       'must_be' => ['SqlField'],
  33       'optional' => TRUE,
  34     ],
  35     [
  36       'prefix' => ['SEPARATOR'],
  37       'expr' => 1,
  38       'must_be' => ['SqlString'],
  39       'optional' => TRUE,
  40     ],
  41   ];
  42
  43   /**
  44    * @return string
  45    */
  46   public static function getTitle(): string {
  47     return ts('List');
  48   }
  49
  50 }