Класс Marshaller

__construct()source public

__construct( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table

Таблица, для которой предназначен этот маршаллер.

_belongsToMany()source protected

_belongsToMany( Cake\ORM\Association\BelongsToMany $assoc , array $data , array $options = [] )

Преобразует данные для ассоциаций belongsToMany.

Создаёт связанные сущности и обрабатывает особые случаи для сущностей таблиц соединения.

Параметры

Cake\ORM\Association\BelongsToMany $assoc

Ассоциация для преобразования.

массив $data

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

массив $options по умолчанию []

Список параметров.

Возвращает

Исключения

_buildPropertyMap()source protected

_buildPropertyMap( array $data , array $options )

Создаёт карту свойств => вызываемых функций для маршаллирования.

Параметры

массив $data

Преобразуемые данные.

массив $options

Список параметров, содержащий ключ 'associated'.

Возвращает

Исключения

_loadAssociatedByIds()source protected

_loadAssociatedByIds( Cake\ORM\Association $assoc , array $ids )

Загружает список принадлежностей many-to-many по идентификаторам.

Параметры

Cake\ORM\Association $assoc

Класс ассоциации для ассоциации belongsToMany.

массив $ids

Список идентификаторов для загрузки.

Возвращает

_loadBelongsToMany()source protected deprecated

_loadBelongsToMany( Cake\ORM\Association $assoc , array $ids )

Загружает список принадлежностей many-to-many по идентификаторам.

Устарело

Параметры

Cake\ORM\Association $assoc

Класс ассоциации для ассоциации belongsToMany.

массив $ids

Список идентификаторов для загрузки.

Возвращает

_marshalAssociation()source protected

_marshalAssociation( Cake\ORM\Association $assoc , array $value , array $options )

Создаёт новый под-маршаллер и преобразует связанные данные.

Параметры

Cake\ORM\Association $assoc

Ассоциация для преобразования

массив $value

Данные для гидратации

массив $options

Список параметров.

Возвращает

_mergeAssociation()source protected

_mergeAssociation( Cake\Datasource\EntityInterface|Cake\Datasource\EntityInterface[] $original , Cake\ORM\Association $assoc , array $value , array $options )

Создаёт новый под-маршаллер и объединяет связанные данные.

Параметры

Cake\Datasource\EntityInterface|Cake\Datasource\EntityInterface[] $original

Исходная сущность

Cake\ORM\Association $assoc

Ассоциация для объединения

массив $value

Данные для гидратации

массив $options

Список параметров.

Возвращает

_mergeBelongsToMany()source protected

_mergeBelongsToMany( Cake\Datasource\EntityInterface $original , Cake\ORM\Association $assoc , array $value , array $options )

Создаёт новый под-маршаллер и объединяет связанные данные для ассоциации BelongstoMany.

Параметры

Cake\Datasource\EntityInterface $original

Исходная сущность

Cake\ORM\Association $assoc

Ассоциация для маршаллирования

массив $value

Данные для гидратации

массив $options

Список параметров.

Возвращает

_mergeJoinData()source protected

_mergeJoinData( Cake\Datasource\EntityInterface $original , Cake\ORM\Association\BelongsToMany $assoc , array $value , array $options )

Объединяет специальное свойство _joinData в набор сущностей.

Параметры

Cake\Datasource\EntityInterface $original

Исходная сущность

Cake\ORM\Association\BelongsToMany $assoc

Ассоциация для маршаллирования

массив $value

Данные для гидратации

массив $options

Список параметров.

Возвращает

_prepareDataAndOptions()source protected

_prepareDataAndOptions( array $data , array $options )

Возвращает данные и параметры, подготовленные для проверки и обработки.

Параметры

массив $data

Данные для подготовки.

массив $options

Параметры, переданные этому обработчику.

Возвращаемое значение

_validate()source protected

_validate( array $data , array $options , boolean $isNew )

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

Параметры

массив $data

Данные для проверки.

массив $options

Параметры, переданные этому обработчику.

логическое значение $isNew

Является ли это новым объектом или объектом для обновления.

Возвращаемое значение

Исключения

many()source public

many( array $data , array $options = [] )

Загрузка нескольких объектов и их связанных данных.

Параметры:

• validate: Установите в значение false, чтобы отключить валидацию. Также может быть строкой правила валидатора, которые нужно применить. По умолчанию true/default.
• associated: Здесь перечислены ассоциации, которые также будут обработаны. По умолчанию null.
• fieldList: (устарело) С версии 3.4.0. Используйте вместо этого fields
• fields: Белый список полей, которые будут назначены объекту. Если отсутствует, будет использоваться список доступных полей в объекте. По умолчанию null.
• accessibleFields: Список полей, разрешаемых или запрещаемых в доступных полях объекта. По умолчанию null
• forceNew: При включенном значении, ассоциации belongsToMany будут иметь созданные «новые» объекты, когда заданы значения первичного ключа, и запись еще не существует. Обычно первичный ключ отсутствующих объектов игнорируется. По умолчанию false.

Параметры

массив $data

Данные для загрузки.

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

Список параметров

Возвращаемое значение

См. также

merge()source public

merge( Cake\Datasource\EntityInterface $entity , array $data , array $options = [] )

Объединяет $data в $entity и рекурсивно выполняет то же самое для каждого имени ассоциации, переданного в $options. При объединении ассоциаций, если объект отсутствует в родительском объекте для данной ассоциации, будет создан новый.

При объединении ассоциаций HasMany или BelongsToMany, все объекты в массиве $data будут отображаться, те, которые можно сопоставить по первичному ключу, получат объединенные данные, а те, которые нельзя, будут отброшены. ids параметр можно использовать для определения того, должна ли ассоциация использовать формат _ids.

Параметры:

• associated: Здесь перечислены ассоциации, которые также будут обработаны.
• validate: Выполнять ли валидацию данных перед загрузкой объектов. Также может быть строкой, использующей конкретный набор правил валидатора. По умолчанию true/default.
• fieldList: (устарело) С версии 3.4.0. Используйте вместо этого fields
• fields: Белый список полей, которые будут назначены объекту. Если отсутствует, будет использоваться список доступных полей в объекте.
• accessibleFields: Список полей, разрешаемых или запрещаемых в доступных полях объекта.

Вышеуказанные параметры могут быть использованы в каждом вложенном массиве associated. В дополнение к вышеуказанным параметрам вы также можете использовать onlyIds параметр для ассоциаций HasMany и BelongsToMany. При значении true этот параметр ограничивает данные запроса чтением только из _ids.

$result = $marshaller->merge($entity, $data, [
  'associated' => ['Tags' => ['onlyIds' => true]]
]);

Параметры

Cake\Datasource\EntityInterface $entity

объект, в который будут объединены данные

массив $data

список пар ключ-значение полей, которые нужно объединить в объект

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

Список параметров.

Возвращаемое значение

См. также

mergeMany()source public

mergeMany( Cake\Datasource\EntityInterface[]|Traversable $entities , array $data , array $options = [] )

Объединяет каждый элемент из $data в каждый объект в $entities и рекурсивно выполняет то же самое для каждого имени ассоциации, переданного в $options. При объединении ассоциаций, если объект отсутствует в родительском объекте для данной ассоциации, будет создан новый.

Записи в $data сопоставляются с объектами с использованием столбца первичного ключа. Записи в $entities , которые не могут быть сопоставлены ни с одной записью в $data, будут отброшены. Записи в $data , которые не могли быть сопоставлены, будут обработаны как новый объект.

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

Параметры:

• validate: Выполнять ли валидацию данных перед загрузкой объектов. Также может быть строкой, использующей конкретный набор правил валидатора. По умолчанию true/default.
• associated: Здесь перечислены ассоциации, которые также будут обработаны.
• fieldList: (устарело) С версии 3.4.0. Используйте вместо этого fields
• fields: Белый список полей, которые будут назначены объекту. Если отсутствует, будет использоваться список доступных полей в объекте.
• accessibleFields: Список полей, разрешаемых или запрещаемых в доступных полях объекта.

Параметры

Cake\Datasource\EntityInterface[]|Проходимый $entities

объекты, в которые будут объединены данные

массив $data

список массивов, которые нужно объединить в объекты

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

Список параметров.

Возвращаемое значение

См. также

one()source public

one( array $data , array $options = [] )

Загрузка одного объекта и его связанных данных.

Параметры:

• validate: Установите в значение false, чтобы отключить валидацию. Также может быть строкой правила валидатора, которые нужно применить. По умолчанию true/default.
• associated: Здесь перечислены ассоциации, которые также будут обработаны. По умолчанию null.
• fieldList: (устарело) С версии 3.4.0. Используйте вместо этого fields.
• fields: Белый список полей, которые будут назначены объекту. Если отсутствует, будет использоваться список доступных полей в объекте. По умолчанию null.
• accessibleFields: Список полей, разрешаемых или запрещаемых в доступных полях объекта. По умолчанию null
• forceNew: При включенном значении, ассоциации belongsToMany будут иметь созданные «новые» объекты, когда заданы значения первичного ключа, и запись еще не существует. Обычно первичный ключ отсутствующих объектов игнорируется. По умолчанию false.

Вышеуказанные параметры могут быть использованы в каждом вложенном массиве associated . В дополнение к вышеуказанным параметрам вы также можете использовать onlyIds параметр для ассоциаций HasMany и BelongsToMany. При значении true этот параметр ограничивает данные запроса чтением только из _ids.

$result = $marshaller->one($data, [
  'associated' => ['Tags' => ['onlyIds' => true]]
]);

Параметры

массив $data

Данные для загрузки.

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

Список параметров

Возвращаемое значение

См. также

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

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

Параметры

массив $associations

Массив включенных ассоциаций.

Возвращаемое значение