Civi/Api4/Query/SqlFunctionNULLIF.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 SqlFunctionNULLIF extends SqlFunction {
  18
  19   public $supportsExpansion = TRUE;
  20
  21   protected static $category = self::CATEGORY_COMPARISON;
  22
  23   protected static function params(): array {
  24     return [
  25       [
  26         'min_expr' => 2,
  27         'max_expr' => 2,
  28         'optional' => FALSE,
  29         'label' => ts('Compare with'),
  30       ],
  31     ];
  32   }
  33
  34   /**
  35    * @return string
  36    */
  37   public static function getTitle(): string {
  38     return ts('Unequal');
  39   }
  40
  41   /**
  42    * @return string
  43    */
  44   public static function getDescription(): string {
  45     return ts('The first value, only if it is not equal to the second.');
  46   }
  47
  48 }