Класс EagerLoader

__clone()source public

__clone( )

Реализация хука клонирования

Клонирует также жадный загрузчик _matching.

_buildAssociationsMap()source protected

_buildAssociationsMap( array $map , array $level , boolean $matching = false )

Внутренний метод для построения карты, используемой для возвращаемого значения метода associationsMap().

Параметры

массив $map

Исходный массив для карты.

массив $level

Массив экземпляров EagerLoadable.

булево $matching по умолчанию false

Является ли это ассоциацией, загруженной через matching().

Возвращает

массив

_collectKeys()source protected

_collectKeys( array $external , Cake\ORM\Query $query , Cake\Database\Statement\BufferedStatement $statement )

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

Параметры

массив $external

список внешних ассоциаций, которые необходимо загрузить

Cake\ORM\Query $query

Запрос, из которого были получены результаты

Cake\Database\Statement\BufferedStatement $statement

Выполняемая команда

Возвращает

массив

_correctStrategy()source protected

_correctStrategy( Cake\ORM\EagerLoadable $loadable )

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

Параметры

Cake\ORM\EagerLoadable $loadable

Настройки ассоциации

_fixStrategies()source protected

_fixStrategies( )

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

Эта функция работает со ссылками на массивы, сгенерированные функцией _normalizeContain().

_groupKeys()source protected

_groupKeys( Cake\Database\Statement\BufferedStatement $statement , array $collectKeys )

Вспомогательная функция для итерации команды и извлечения столбцов, определенных в $collectKeys.

Параметры

Cake\Database\Statement\BufferedStatement $statement

Команда для чтения.

массив $collectKeys

Ключи для сбора

Возвращает

массив

_normalizeContain()source protected

_normalizeContain( Cake\ORM\Table $parent , string $alias , array $options , array $paths )

Вспомогательная функция, отвечающая за полную нормализацию глубоких ассоциаций, определенных с использованием contain().

Параметры

Cake\ORM\Table $parent

Владеющая сторона ассоциации

строка $alias

Имя ассоциации для загрузки

массив $options

Список дополнительных параметров для этой ассоциации

массив $paths

Массив из двух значений: первый — список строк, разделенных точками, представляющих ассоциации, ведущие к этой $alias в цепочке загружаемых ассоциаций. Второе значение — путь для поиска записи соответствующей ассоциации в свойствах сущностей.

Возвращает

Cake\ORM\EagerLoadable
Объект с нормализованными ассоциациями

Выбрасывает

InvalidArgumentException
Когда указания содержат ссылки на несуществующие ассоциации.

_reformatContain()source protected

_reformatContain( array $associations , array $original )

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

Параметры

массив $associations

массив содержаний, предоставленный пользователем

массив $original

Исходный массив содержаний для объединения с новым массивом

Возвращает

массив

_resolveJoins()source protected

_resolveJoins( array $associations , array $matching = [] )

Вспомогательная функция для компиляции списка всех ассоциаций, которые могут быть объединены в запросе.

Параметры

массив $associations

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

массив $matching дополнительно []

список ассоциаций, которые должны быть принудительно объединены.

Возвращает

массив

addToJoinsMap()source public

addToJoinsMap( string $alias , Cake\ORM\Association $assoc , boolean $asMatching = false , string $targetProperty = null )

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

Параметры

строка $alias

Псевдоним таблицы, как он появляется в запросе.

Cake\ORM\Association $assoc

Объект ассоциации, который представляет псевдоним; будет нормализован

булево $asMatching дополнительно false

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

строка $targetProperty дополнительно null

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

associationsMap()source public

associationsMap( Cake\ORM\Table $table )

Возвращает массив, ключами которого является путь с точками ассоциаций, участвующих в этом леничном загрузчике. Значения массива будут содержать следующие ключи:

• alias: псевдоним ассоциации
• instance: экземпляр ассоциации
• canBeJoined: возможно ли загрузить ассоциацию с помощью JOIN
• entityClass: сущность, которая должна использоваться для хидрации результатов
• nestKey: путь с точками, который можно использовать для правильной вставки данных в результаты.
• matching: является ли это ассоциацией, загруженной с помощью matching().

Параметры

Cake\ORM\Table $table

Таблица, содержащая ассоциацию, которая будет нормализована

Возвращает

массив

attachAssociations()source public

attachAssociations( Cake\ORM\Query $query , Cake\ORM\Table $repository , boolean $includeFields )

Изменяет переданный запрос, чтобы применить объединения или любые другие преобразования, необходимые для леничной загрузки ассоциаций, описанных в массиве contain. Этот метод не будет изменять запрос для загрузки внешних ассоциаций, т. е. тех, которые нельзя загрузить без выполнения отдельного запроса.

Параметры

Cake\ORM\Query $query

Запрос, который нужно изменить

Cake\ORM\Table $repository

Репозиторий, содержащий ассоциации

булево $includeFields

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

attachableAssociations()source public

attachableAssociations( Cake\ORM\Table $repository )

Возвращает массив с ассоциациями, которые можно получить с помощью одного запроса. Ключами массива являются псевдонимы ассоциаций, а значениями — массив объектов Cake\ORM\EagerLoadable.

Параметры

Cake\ORM\Table $repository

Таблица, содержащая ассоциации, которые должны быть добавлены

Возвращает

массив

autoFields()source public deprecated

autoFields( boolean|null $enable = null )

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

Устарело

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

Параметры

булево|null $enable дополнительно null

Значение для установки.

Возвращает

булево
Текущее значение.

clearContain()source public

clearContain( )

Удаляет все существующие содержащие ассоциации, основанные на несоответствии.

Это сбросит/очистит все содержащие ассоциации, которые не были добавлены с помощью matching().

contain()source public

contain( array|string $associations = [] , callable $queryBuilder = null )

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

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

Часть получения данных устарела начиная с версии 3.6.0. Используйте вместо этого getContain().

Допустимые параметры для каждой переданной ассоциации:

• foreignKey: Используется для установки другого поля для сопоставления обеих таблиц. Если установлено в false, автоматически не будут генерироваться условия объединения.
• fields: Массив полей, которые должны быть извлечены из ассоциации.
• queryBuilder: Эквивалентно передаче вызываемого объекта вместо массива параметров.
• matching: Указывает классу ассоциации, что он должен отфильтровать основной запрос по результатам, полученным этим классом.
• joinType: Для объединяемых ассоциаций - тип SQL-объединения, который следует использовать.
• strategy: Стратегия загрузки (объединение, выборка, подзапрос).

Параметры

массив|строка $associations необязательно []

Список псевдонимов таблиц, которые будут запрошены. При многократном вызове этого метода предыдущий список будет сливаться с новым.

вызываемый объект $queryBuilder необязательно null

Вызываемый объект для построения запроса.

Возвращает

массив
Содержимое.

Исключения

InvalidArgumentException
При использовании $queryBuilder с массивом $associations

enableAutoFields()source public

enableAutoFields( boolean $enable = true )

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

Параметры

булево $enable необязательно true

Значение для установки.

Возвращает

$this

externalAssociations()source public

externalAssociations( Cake\ORM\Table $repository )

Возвращает массив ассоциаций, которые необходимо загрузить с помощью отдельного запроса. Каждый элемент массива будет содержать объект Cake\ORM\EagerLoadable.

Параметры

Cake\ORM\Table $repository

Таблица, содержащая ассоциации для загрузки.

Возвращает

Cake\ORM\EagerLoadable[]

getContain()source public

getContain( )

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

Возвращает

массив
Содержимое.

getMatching()source public

getMatching( )

Возвращает текущее дерево ассоциаций для сопоставления.

Возвращает

массив
Результирующий массив содержаний

isAutoFieldsEnabled()source public

isAutoFieldsEnabled( )

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

Возвращает

булево
Текущее значение.

loadExternal()source public

loadExternal( Cake\ORM\Query $query , Cake\Database\StatementInterface $statement )

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

Параметры

Cake\ORM\Query $query

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

Cake\Database\StatementInterface $statement

Запрос, созданный после выполнения $query.

Возвращает

Cake\Database\StatementInterface
Изменённый объект запроса с дополнительными загрузчиками

matching()source public deprecated

matching( string|null $assoc = null , callable $builder = null , array $options = [] )

Добавляет новую ассоциацию в список, который будет использоваться для фильтрации результатов любого запроса на основе результатов поиска записей для этой ассоциации. Вы можете передать путь к ассоциациям, разделённый точками, в качестве первого параметра этого метода. Это приведет к установке всех этих ассоциаций с опцией matching.

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

Устаревшее

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

Параметры

строка|null $assoc необязательно null

Одна ассоциация или путь к ассоциациям, разделённый точками.

вызываемый объект $builder необязательно null

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

массив $options необязательно []

Дополнительные параметры для сопоставления ассоциаций, такие как 'joinType' и 'fields'.

Возвращает

массив
Результирующий массив содержаний

normalized()source public

normalized( Cake\ORM\Table $repository )

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

Каждый уровень дерева ассоциаций будет преобразован в объект Cake\ORM\EagerLoadable, содержащий всю необходимую информацию для объектов ассоциаций, чтобы загрузить информацию из базы данных.

Кроме того, он установит ключ 'instance' для каждой ассоциации, содержащий экземпляр ассоциации из соответствующей исходной таблицы.

Параметры

Cake\ORM\Table $repository

Таблица, содержащая ассоциацию, которая будет нормализована.

Возвращает

массив

setMatching()source public

setMatching( string $assoc , callable $builder = null , array $options = [] )

Добавляет новую ассоциацию в список, который будет использоваться для фильтрации результатов любого запроса на основе результатов поиска записей для этой ассоциации. Вы можете передать путь к ассоциациям, разделённый точками, в качестве первого параметра этого метода. Это приведёт к установке всех этих ассоциаций с опцией matching.

Параметры

• 'joinType': INNER, OUTER, ...
• 'fields': Поля для включения

Параметры

строка $assoc

Одна ассоциация или путь к ассоциациям, разделённый точками.

вызываемый объект $builder необязательно null

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

массив $options необязательно []

Дополнительные параметры для сопоставления ассоциаций.

Возвращает

$this

[]

true

[
    'associations' => 1,
    'foreignKey' => 1,
    'conditions' => 1,
    'fields' => 1,
    'sort' => 1,
    'matching' => 1,
    'queryBuilder' => 1,
    'finder' => 1,
    'joinType' => 1,
    'strategy' => 1,
    'negateMatch' => 1
]

[]

[]

[]