Spec-Zone.ru › CakePHP 3.6

Класс TupleComparison

Это выражение представляет фрагменты SQL, используемые для сравнения одной кортежа с другой, одной кортежи с набором других кортежей или одной кортежи с выражением

Cake\Database\Expression\Comparison реализует Cake\Database\ExpressionInterface, Cake\Database\Expression\FieldInterface использует Cake\Database\Type\ExpressionTypeCasterTrait , Cake\Database\Expression\FieldTrait
Extended by Cake\Database\Expression\TupleComparison
Пространство имён: Cake\Database\Expression
Расположение: Database/Expression/TupleComparison.php

Наследуемые свойства

  • _isMultiple, _operator, _type, _value, _valueExpressions _field

Краткое описание методов

  • __construct() public
    Конструктор
  • _bindValue() protected

    Регистрирует значение в генераторе плейсхолдеров и возвращает сгенерированный плейсхолдер

  • _stringifyValues() protected

    Возвращает строку со значениями в виде плейсхолдеров в строке, которая будет использоваться для SQL-версии этого выражения

  • _traverseValue() protected

    Условно выполняет обратный вызов для переданного значения, если это ExpressionInterface

  • isMulti() public

    Определяет, является ли каждое из значений в этом выражении кортежем

  • sql() public
    Преобразование выражения в фрагмент SQL.
  • traverse() public

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

Подробное описание методов

__construct()source public

__construct( string|array|Cake\Database\ExpressionInterface $fields , array|Cake\Database\ExpressionInterface $values , array $types = [] , string $conjunction = '=' )

Конструктор

Параметры

строка|массив|Cake\Database\ExpressionInterface $fields
поля, используемые для формирования кортежа
массив|Cake\Database\ExpressionInterface $values
значения, используемые для формирования кортежа
массив $types необязательно []

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

строка $conjunction необязательно '='
оператор, используемый для сравнения поля и значения

Переопределяет

Cake\Database\Expression\Comparison::__construct()

_bindValue()source protected

_bindValue( Cake\Database\ValueBinder $generator , mixed $value , string $type )

Регистрирует значение в генераторе плейсхолдеров и возвращает сгенерированный плейсхолдер

Параметры

Cake\Database\ValueBinder $generator
объект-связыватель значений
смешанное $value
значение для привязки
строка $type
тип для использования

Возвращает

строка
сгенерированный плейсхолдер

Переопределяет

Cake\Database\Expression\Comparison::_bindValue()

_stringifyValues()source protected

_stringifyValues( Cake\Database\ValueBinder $generator )

Возвращает строку со значениями в виде плейсхолдеров в строке, которая будет использоваться для SQL-версии этого выражения

Параметры

Cake\Database\ValueBinder $generator
связыватель значений для преобразования выражений

Возвращает

строка

_traverseValue()source protected

_traverseValue( mixed $value , callable $callable )

Условно выполняет обратный вызов для переданного значения, если это ExpressionInterface

Параметры

смешанное $value
значение для обхода
вызываемый объект $callable
вызываемый объект для использования при обходе

isMulti()source public

isMulti( )

Определяет, является ли каждое из значений в этом выражении кортежем

Возвращает

boolean

sql()source public

sql( Cake\Database\ValueBinder $generator )

Преобразует выражение в фрагмент SQL.

Параметры

Cake\Database\ValueBinder $generator
объект генератора плейсхолдеров

Возвращает

строка

Переопределяет

Cake\Database\Expression\Comparison::sql()

traverse()source public

traverse( callable $callable )

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

Функция обратного вызова получает в качестве единственного аргумента экземпляр ExpressionInterface

Параметры

вызываемый объект $callable
вызываемый объект, который нужно применить к подвыражениям

Переопределяет

Cake\Database\Expression\Comparison::traverse()

Методы, унаследованные от Cake\Database\Expression\Comparison

__clone()source public

__clone( )

Создаёт глубокую копию.

Клонирует поле и значение, если они являются объектами выражения.

_collectExpressions()source protected

_collectExpressions( array|Traversable $values )

Возвращает массив с исходными значениями $values на первом месте и всеми объектами ExpressionInterface, которые можно найти на втором месте.

Параметры

массив|Перечислимый $values
строки для вставки

Возвращает

массив

_flattenValue()source protected

_flattenValue( array|Traversable $value , Cake\Database\ValueBinder $generator , string|array|null $type = 'string' )

Преобразует перечисляемое значение в набор плейсхолдеров, сгенерированных $generator и разделенных ,

Параметры

массив|Перечислимый $value
значение для уплощения
Cake\Database\ValueBinder $generator
используемый связыватель значений
строка|массив|null $type необязательно 'string'
тип, к которому преобразовать значения

Возвращает

строка

_stringExpression()source protected

_stringExpression( Cake\Database\ValueBinder $generator )

Возвращает шаблон и плейсхолдер для значения после регистрации его с плейсхолдером $generator

Параметры

Cake\Database\ValueBinder $generator
используемый связыватель значений.

Возвращает

массив
Первый элемент содержит шаблон, а второй - плейсхолдер

getOperator()source public

getOperator( )

Возвращает оператор, используемый для сравнения

Возвращает

строка

getValue()source public

getValue( )

Возвращает значение, используемое для сравнения

Возвращает

смешанное
END_OF_DOCUMENT_MARKER

setOperator()source public

setOperator( string $operator )

Устанавливает оператор для сравнения

Параметры

строка $operator
Оператор, который будет использоваться для сравнения.

setValue()source public

setValue( mixed $value )

Устанавливает значение

Параметры

смешанный $value
Значение для сравнения

Методы, используемые из Cake\Database\Type\ExpressionTypeCasterTrait

_castToExpression()source protected

_castToExpression( mixed $value , string $type )

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

Параметры

смешанный $value
Значение для преобразования в ExpressionInterface
строка $type
Имя типа

Возвращает

смешанный

_requiresToExpressionCasting()source protected

_requiresToExpressionCasting( array $types )

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

Параметры

массив $types
Список имен типов

Возвращает

массив

Методы, используемые из Cake\Database\Expression\FieldTrait

getField()source public

getField( )

Возвращает имя поля

Возвращает

строка|Cake\Database\ExpressionInterface

setField()source public

setField( string|Cake\Database\ExpressionInterface $field )

Устанавливает имя поля

Параметры

строка|Cake\Database\ExpressionInterface $field
Поле для сравнения.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Database.Expression.TupleComparison.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API