Класс CaseStatementExpression

Клонирует внутренние объекты выражений.

Возвращает

Конструктор.

При установке значения генерируется синтаксис CASE case_value WHEN when_value ... END (простой случай), где when_value сравниваются с case_value.

При отсутствии значения генерируется синтаксис CASE WHEN when_conditions ... END (случай поиска), где условия содержат сравнения.

Обратите внимание, что null является допустимым значением случая и, следовательно, должно передаваться только в том случае, если вы действительно хотите создать вариант выражения простого случая!

Параметры

Условно преобразует переданное значение в объект ExpressionInterface, если класс типа реализует ExpressionTypeInterface. В противном случае возвращает значение без изменений.

Параметры

Возвращает

Возвращает массив с типами, для которых значения должны быть преобразованы в выражения из списка имен типов, переданных в качестве параметра.

Параметры

Возвращает

Возвращает доступные данные для заданного условия.

Доступные условия

Доступны следующие имена условий:

• value: Значение случая для выражения CASE case_value WHEN ....
• when: Массив выражений WHEN ... THEN ....
• else: Значение результата ELSE.

Параметры

Возвращает

Исключения

Компилирует значение NULL в SQL.

Параметры

Возвращает

Устанавливает значение результата ELSE.

Параметры

Возвращает

Исключения

Получает типы по умолчанию для текущей карты типов.

Возвращает

Возвращает абстрактный тип, который вернёт это выражение.

Если тип не был явно задан с помощью setReturnType(), этот метод попытается получить тип из типов результатов вызовов then() и else(). Все типы должны быть идентичны, чтобы это работало, в противном случае тип по умолчанию будет string.

Возвращает

См. также

Возвращает существующую карту типов.

Возвращает

Определяет абстрактный тип для данного значения.

Параметры

Возвращает

Перезаписывает сопоставления типов по умолчанию для полей в объекте-реализации.

Этот метод полезен, если вам нужно установить сопоставления типов, которые используются совместно несколькими функциями/выражениями в запросе.

Чтобы добавить значение по умолчанию без перезаписи существующих, используйте getTypeMap()->addDefaults()

Параметры

Возвращает

См. также

Устанавливает абстрактный тип, который вернёт это выражение.

Если тип не задан явно через этот метод, то метод getReturnType() попытается определить тип из типов результатов вызовов then() и else().

Параметры

Возвращает

Создаёт новую карту типов, если $typeMap является массивом, иначе обменивает её на заданную.

Параметры

Возвращает

Преобразует узел в фрагмент SQL-строки.

Параметры

Возвращает

Устанавливает значение результата THEN для последнего условия WHEN ... THEN ... , которое было открыто с помощью when().

Синтаксис на основе порядка

Этот метод может быть вызван только в случае, если when() ранее использовался со значением, отличным от замыкания или экземпляра \Cake\Database\Expression\WhenThenExpression:

$case
    ->when(['Table.column' => true])
    ->then('Yes')
    ->when(['Table.column' => false])
    ->then('No')
    ->else('Maybe');

Следующие варианты приведут к ошибке:

$case
    ->when(['Table.column' => true])
    ->when(['Table.column' => false])
    // ...

$case
    ->when(['Table.column' => true])
    ->else('Maybe')
    // ...

$case
    ->then('Yes')
    // ...

$case
    ->when(['Table.column' => true])
    ->then('Yes')
    ->then('No')
    // ...

Параметры

Возвращает

Исключения

Рекурсивно перебирает каждую часть выражения на каждом уровне дерева выражений и выполняет вызов $callback, передавая в качестве первого параметра экземпляр текущего выражения.

Параметры

Возвращает

Устанавливает значение WHEN для выражения WHEN ... THEN ..., или самодостаточного выражения, содержащего значение для WHEN и значение для THEN.

Синтаксис на основе порядка

При передаче значения, отличного от самодостаточного \Cake\Database\Expression\WhenThenExpression, экземпляра, оператор WHEN ... THEN ... должен быть закрыт вызовом then() перед повторным вызовом when() или else():

$queryExpression
    ->case($query->identifier('Table.column'))
    ->when(true)
    ->then('Yes')
    ->when(false)
    ->then('No')
    ->else('Maybe');

Самодостаточные выражения

При передаче экземпляра \Cake\Database\Expression\WhenThenExpression, будь то напрямую или через вызываемую функцию, нет необходимости закрывать этот объект с помощью then(), вместо этого оператор будет закрыт для объекта \Cake\Database\Expression\WhenThenExpression с помощью \Cake\Database\Expression\WhenThenExpression::then().

Вызываемые функции будут получать экземпляр \Cake\Database\Expression\WhenThenExpression, и должны возвращать один, будь то тот же объект или настраиваемый:

$queryExpression
    ->case()
    ->when(function (\Cake\Database\Expression\WhenThenExpression $whenThen) {
        return $whenThen
            ->when(['Table.column' => true])
            ->then('Yes');
    })
    ->when(function (\Cake\Database\Expression\WhenThenExpression $whenThen) {
        return $whenThen
            ->when(['Table.column' => false])
            ->then('No');
    })
    ->else('Maybe');

Обработка типов

Типы, предоставленные через аргумент $type , будут объединены с картой типов, установленной для этого выражения. При использовании вызываемых функций для $when, экземпляр \Cake\Database\Expression\WhenThenExpression , полученный вызываемыми функциями, унаследует эту карту типов, однако переданные здесь типы не будут объединены в случае использования вызываемых функций, вместо этого типы должны быть переданы в \Cake\Database\Expression\WhenThenExpression::when():

$queryExpression
    ->case()
    ->when(function (\Cake\Database\Expression\WhenThenExpression $whenThen) {
        return $whenThen
            ->when(['unmapped_column' => true], ['unmapped_column' => 'bool'])
            ->then('Yes');
    })
    ->when(function (\Cake\Database\Expression\WhenThenExpression $whenThen) {
        return $whenThen
            ->when(['unmapped_column' => false], ['unmapped_column' => 'bool'])
            ->then('No');
    })
    ->else('Maybe');

Безопасность пользовательских данных

При передаче пользовательских данных, помните, что разрешение передачи массива, определенного пользователем, представляет собой потенциальную уязвимость SQL-инъекции, поскольку это позволяет проникать необработанному SQL!

Следующее использование небезопасно и должно быть избегаемо:

$case
     ->when($userData)

Безопасным вариантом для вышеуказанного будет определение единственного типа для значения:

$case
     ->when($userData, 'integer')

Таким образом, при передаче массива для значения будет генерироваться исключение, предотвращая проникновение необработанного SQL, и все другие типы значений будут принудительно связаны как целые числа.

Другой способ безопасно передать пользовательские данные — при использовании массива условий и передача пользовательских данных только со стороны значений записей массива, что приведет к их привязке:

$case
     ->when([
         'Table.column' => $userData,
     ])

Наконец, данные также можно привязать вручную:

$query
     ->select([
         'val' => $query->newExpr()
             ->case()
             ->when($query->newExpr(':userData'))
             ->then(123)
     ])
     ->bind(':userData', $userData, 'integer')

Параметры

Возвращает

Выбрасывает