Civi/Api4/Query/SqlFunctionISNULL.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 SqlFunctionISNULL extends SqlFunction {
  18
  19   protected static $category = self::CATEGORY_COMPARISON;
  20
  21   protected static $dataType = 'Boolean';
  22
  23   protected static function params(): array {
  24     return [
  25       [
  26         'optional' => FALSE,
  27       ],
  28     ];
  29   }
  30
  31   /**
  32    * @return string
  33    */
  34   public static function getTitle(): string {
  35     return ts('Is null');
  36   }
  37
  38   /**
  39    * @return string
  40    */
  41   public static function getDescription(): string {
  42     return ts('TRUE if the value is NULL, otherwise FALSE.');
  43   }
  44
  45 }