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 $params = [
  22     [
  23       'optional' => FALSE,
  24     ],
  25   ];
  26
  27   /**
  28    * @return string
  29    */
  30   public static function getTitle(): string {
  31     return ts('Is null');
  32   }
  33
  34   /**
  35    * Reformat result as boolean
  36    *
  37    * @see \Civi\Api4\Utils\FormattingUtil::formatOutputValues
  38    * @param string $value
  39    * @param string $dataType
  40    * @return string|array
  41    */
  42   public function formatOutputValue($value, &$dataType) {
  43     // Value is always TRUE or FALSE
  44     $dataType = 'Boolean';
  45     return $value;
  46   }
  47
  48 }