Spec-Zone.ru › CakePHP 4.2

Класс CommonTableExpression

Выражение, представляющее определение общего табличного выражения.

Пространство имён: Cake\Database\Expression

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

  • $fields protected
    Cake\Database\Expression\IdentifierExpression[]

    Имена полей для использования в CTE.

  • $materialized protected
    string|null

    Является ли CTE материализованным.

  • $name protected
    Cake\Database\Expression\IdentifierExpression

    Имя CTE.

  • $query protected
    Cake\Database\ExpressionInterface|null

    Определение запроса CTE.

  • $recursive protected
    bool

    Является ли CTE рекурсивным.

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

  • __clone() public

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

  • __construct() public

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

  • field() public

    Добавляет одно или несколько полей (аргументов) в CTE.

  • isRecursive() public

    Получает, является ли данное CTE рекурсивным.

  • materialized() public

    Устанавливает CTE как материализованный.

  • name() public

    Устанавливает имя данного CTE.

  • notMaterialized() public

    Устанавливает CTE как не материализованный.

  • query() public

    Устанавливает запрос для данного CTE.

  • recursive() public

    Устанавливает CTE как рекурсивный.

  • sql() public

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

  • traverse() public

    Проходит по каждой части выражения рекурсивно для каждого уровня дерева выражений и выполняет вызов $callback, передавая в качестве первого параметра экземпляр выражения, по которому в данный момент происходит итерация.

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

__clone() public

__clone(): void

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

Возвращает

void

__construct() public

__construct(string $name = '', ClosureCake\Database\ExpressionInterface $query = null)

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

Параметры

string $name необязательно

Имя CTE.

ClosureCake\Database\ExpressionInterface $query необязательно

Запрос CTE

field() public

field(string|string[]Cake\Database\Expression\IdentifierExpressionCake\Database\Expression\IdentifierExpression[] $fields): $this

Добавляет одно или несколько полей (аргументов) в CTE.

Параметры

string|string[]Cake\Database\Expression\IdentifierExpressionCake\Database\Expression\IdentifierExpression[] $fields

Имена полей

Возвращает

$this

isRecursive() public

isRecursive(): bool

Получает, является ли данное CTE рекурсивным.

Возвращает

bool

materialized() public

materialized(): $this

Устанавливает CTE как материализованный.

Возвращает

$this

name() public

name(string $name): $this

Устанавливает имя данного CTE.

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

Параметры

string $name

Имя CTE.

Возвращает

$this

notMaterialized() public

notMaterialized(): $this

Устанавливает CTE как не материализованный.

Возвращает

$this

query() public

query(ClosureCake\Database\ExpressionInterface $query): $this

Устанавливает запрос для данного CTE.

Параметры

ClosureCake\Database\ExpressionInterface $query

Запрос CTE

Возвращает

$this

recursive() public

recursive(): $this

Устанавливает CTE как рекурсивный.

Возвращает

$this

sql() public

sql(Cake\Database\ValueBinder $binder): string

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

Параметры

Cake\Database\ValueBinder $binder

Возвращает

string

traverse() public

traverse(Closure $callback): $this

Проходит по каждой части выражения рекурсивно для каждого уровня дерева выражений и выполняет вызов $callback, передавая в качестве первого параметра экземпляр выражения, по которому в данный момент происходит итерация.

Параметры

Closure $callback

Возвращает

$this

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

$fields protected

Имена полей для использования в CTE.

Тип

Cake\Database\Expression\IdentifierExpression[]

$materialized protected

Является ли CTE материализованным.

Тип

string|null

$name protected

Имя CTE.

Тип

Cake\Database\Expression\IdentifierExpression

$query protected

Определение запроса CTE.

Тип

Cake\Database\ExpressionInterface|null

$recursive protected

Является ли CTE рекурсивным.

Тип

bool

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

Spec-Zone.ru

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