Spec-Zone.ru › CakePHP 3.8

Класс ValuesExpression

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

Помогает сгенерировать SQL с правильным количеством заглушек и корректно связать значения в операторе.

Cake\Database\Expression\ValuesExpression реализует Cake\Database\ExpressionInterface использует Cake\Database\Type\ExpressionTypeCasterTrait , Cake\Database\TypeMapTrait
Пространство имён: Cake\Database\Expression
Расположение: Database/Expression/ValuesExpression.php

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

  • $_castedExpressions protected
    boolean

    Указывает, были ли значения уже преобразованы в выражения.

  • $_columns protected
    array
    Список столбцов, которые должны быть частью вставки.
  • $_query protected
    Cake\Database\Query|null
    Объект запроса, используемый как выражение значений.
  • $_values protected
    array
    Массив значений для вставки.

Унаследованные свойства

  • _typeMap

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

  • __construct() public
    Конструктор
  • _columnNames() protected
    Получить имена столбцов без квалификаторов.
  • _processExpressions() protected
    Преобразует значения, которые нужно преобразовать в выражения.
  • add() public
    Добавить строку данных для вставки.
  • columns() public deprecated

    Устанавливает столбцы для вставки. Если параметры не переданы, возвращает текущие сохранённые столбцы.

  • getColumns() public
    Получить столбцы для вставки.
  • getQuery() public

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

  • getValues() public
    Получить значения для вставки.
  • query() public deprecated

    Устанавливает объект запроса, используемый как выражение значений для оценки вставки записей в таблицу. Если параметры не переданы, возвращает текущий сохранённый запрос.

  • setColumns() public
    Устанавливает столбцы для вставки.
  • setQuery() public

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

  • setValues() public
    Устанавливает значения для вставки.
  • sql() public
    Преобразовать значения в строку SQL с заглушками.
  • traverse() public
    Обработать выражение значений.
  • values() public deprecated

    Устанавливает значения для вставки. Если параметры не переданы, возвращает текущие сохранённые значения.

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

__construct()source public

__construct( array $columns , Cake\Database\TypeMap $typeMap )

Конструктор

Параметры

массив $columns
Список столбцов, которые будут частью значений.
Cake\Database\TypeMap $typeMap
Словарь столбец -> имя типа

_columnNames()source protected

_columnNames( )

Получить имена столбцов без квалификаторов.

Поскольку имена столбцов могут быть в кавычках, нам нужно удалить квалификаторы из столбцов.

Возвращает

массив

_processExpressions()source protected

_processExpressions( )

Преобразует значения, которые нужно преобразовать в выражения

add()source public

add( array|Cake\Database\Query $data )

Добавить строку данных для вставки.

Параметры

массив|Cake\Database\Query $data

Массив данных для добавления в вставку или запрос для команд типа INSERT INTO .. SELECT

Исключения

Cake\Database\Exception
При смешивании массивов и объектов запроса.

columns()source public deprecated

columns( array|null $cols = null )

Устанавливает столбцы для вставки. Если параметры не переданы, возвращает текущие сохранённые столбцы.

Устарело

3.4.0 Используйте setColumns()/getColumns() вместо этого.

Параметры

массив|null $cols optional null
Массив с столбцами для вставки.

Возвращает

массив|Cake\Database\Expression\ValuesExpression
$this

getColumns()source public

getColumns( )

Получить столбцы для вставки.

Возвращает

массив

getQuery()source public

getQuery( )

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

Возвращает

объект запроса|null

getValues()source public

getValues( )

Получить значения для вставки.

Возвращает

массив

query()source public deprecated

query( Cake\Database\Query $query = null )

Устанавливает объект запроса, используемый как выражение значений для оценки вставки записей в таблицу. Если параметры не переданы, возвращает текущий сохранённый запрос

Устарело

3.4.0 Используйте setQuery()/getQuery() вместо этого.

Параметры

Cake\Database\Query $query optional null
Запрос для установки

Возвращает

объект запроса|null|Cake\Database\Expression\ValuesExpression
$this

setColumns()source public

setColumns( array $cols )

Устанавливает столбцы для вставки.

Параметры

массив $cols
Массив с столбцами для вставки.

Возвращает


$this

setQuery()source public

setQuery( Cake\Database\Query $query )

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

Параметры

Cake\Database\Query $query
Запрос для установки

Возвращает


$this
END_OF_DOCUMENT_MARKER

setValues()source public

setValues( array $values )

Устанавливает значения для вставки.

Параметры

массив $values
Массив со значениями для вставки.

Возвращает


$this

sql()source public

sql( Cake\Database\ValueBinder $generator )

Преобразует значения в строку SQL с заглушками.

Параметры

Cake\Database\ValueBinder $generator
Объект генератора заглушек

Возвращает

строка

Реализация

Cake\Database\ExpressionInterface::sql()

traverse()source public

traverse( callable $visitor )

Проходим по выражению значений.

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

Параметры

обратный вызов $visitor
Посетитель для обхода выражения.

Реализация

Cake\Database\ExpressionInterface::traverse()

values()source public deprecated

values( array|null $values = null )

Устанавливает значения для вставки. Если параметры не переданы, то возвращаются текущие сохраненные значения

Устарело

3.4.0 Используйте setValues()/getValues() вместо этого.

Параметры

массив|null $values необязательно null
Массив со значениями для вставки.

Возвращает

массив|Cake\Database\Expression\ValuesExpression
$this

Методы, используемые из 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\TypeMapTrait

defaultTypes()source public deprecated

defaultTypes( array $types = null )

Разрешает устанавливать значения по умолчанию при цепочке запросов

Устарело

3.4.0 Используйте setDefaultTypes()/getDefaultTypes() вместо этого.

Параметры

массив $types необязательно null
Массив типов для установки.

Возвращает


$this|массив

getDefaultTypes()source public

getDefaultTypes( )

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

Возвращает

массив

getTypeMap()source public

getTypeMap( )

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

Возвращает

Cake\Database\TypeMap

setDefaultTypes()source public

setDefaultTypes( array $types )

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

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

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

Параметры

массив $types
Массив типов для установки.

Возвращает


$this

См.

\Cake\Database\TypeMap::setDefaults()

setTypeMap()source public

setTypeMap( array|Cake\Database\TypeMap $typeMap )

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

Параметры

массив|Cake\Database\TypeMap $typeMap
Создает карту типов, если массив, иначе устанавливает заданную карту типов

Возвращает


$this

typeMap()source public deprecated

typeMap( array|Cake\Database\TypeMap|null $typeMap = null )

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

Устарело

3.4.0 Используйте setTypeMap()/getTypeMap() вместо этого.

Параметры

массив|Cake\Database\TypeMap|null $typeMap необязательно null
Создает карту типов, если массив, иначе устанавливает заданную карту типов

Возвращает


$this|\Cake\Database\TypeMap

Подробности свойств

$_castedExpressionssource

protected boolean

Булево значение, указывающее, были ли значения уже преобразованы в выражения.

false

$_columnssource

protected массив

Список столбцов, для включения в вставку.

[]

$_querysource

protected Cake\Database\Query|null

Объект запроса для использования в качестве выражения значений

$_valuessource

protected массив

Массив значений для вставки.

[]

© 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.8/class-Cake.Database.Expression.ValuesExpression.html

Spec-Zone.ru

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