Spec-Zone.ru › CakePHP 3.4

Класс SaveOptionsBuilder

Библиотека для создания опций сохранения сущностей в стиле ООП.

Это позволяет создавать опции сохранения сущностей в стиле ООП и помогает избежать ошибок, валидируя опции по мере их создания.

ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Cake\ORM\SaveOptionsBuilder использует Cake\ORM\AssociationsNormalizerTrait
Пространство имён: Cake\ORM
См.: Cake\Datasource\RulesChecker
Расположение: ORM/SaveOptionsBuilder.php

Наследованные константы

  • ARRAY_AS_PROPS, STD_PROP_LIST

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

  • $_options protected
    array
    Опции
  • $_table protected
    Cake\ORM\Table
    Объект таблицы.

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

  • __construct() public
    Конструктор.
  • _associated() protected
    Проверяет существование ассоциаций рекурсивно.
  • _checkAssociation() protected
    Проверяет существование ассоциации.
  • associated() public
    Устанавливает опции ассоциаций.
  • atomic() public
    Устанавливает атомарную опцию.
  • checkExisting() public
    Устанавливает опцию проверки существующего объекта.
  • checkRules() public
    Опция проверки правил.
  • guard() public
    Устанавливает опцию защиты.
  • parseArrayOptions() public
    Принимает массив опций и заполняет объект опций данными.
  • set() public
    Установка пользовательских опций.
  • toArray() public
  • validate() public
    Устанавливает набор правил валидации.

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

__construct()source public

__construct( Cake\ORM\Table $table , array $options [] )

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

Параметры

Cake\ORM\Table $table
Экземпляр таблицы.
массив $options необязательно []
Опции для обработки при создании.

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

ArrayObject::__construct()

_associated()source protected

_associated( Cake\ORM\Table $table , array $associations )

Проверяет существование ассоциаций рекурсивно.

Параметры

Cake\ORM\Table $table
Объект таблицы.
массив $associations
Массив ассоциаций.

_checkAssociation()source protected

_checkAssociation( Cake\ORM\Table $table , string $association )

Проверяет существование ассоциации.

Параметры

Cake\ORM\Table $table
Объект таблицы.
строка $association
Имя ассоциации.

Возможные исключения

RuntimeException
Если такая ассоциация не существует для данной таблицы.

associated()source public

associated( string|array $associated )

Устанавливает опции ассоциаций.

Параметры

строка|массив $associated
Строка или массив ассоциаций.

Возвращает

Cake\ORM\SaveOptionsBuilder

atomic()source public

atomic( boolean $atomic )

Устанавливает атомарную опцию.

Параметры

логическое значение $atomic
Атомарно или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

checkExisting()source public

checkExisting( boolean $checkExisting )

Устанавливает опцию проверки существующего объекта.

Параметры

логическое значение $checkExisting
Защищать свойства или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

checkRules()source public

checkRules( boolean $checkRules )

Опция проверки правил.

Параметры

логическое значение $checkRules
Проверить правила или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

guard()source public

guard( boolean $guard )

Устанавливает опцию защиты.

Параметры

логическое значение $guard
Защищать свойства или нет.

Возвращает

Cake\ORM\SaveOptionsBuilder

parseArrayOptions()source public

parseArrayOptions( array $array )

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

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

Параметры

массив $array
Массив опций.

Возвращает

Cake\ORM\SaveOptionsBuilder

Возможные исключения

InvalidArgumentException
Если заданного ключа опции не существует.

set()source public

set( string $option , mixed $value )

Установка пользовательских опций.

Параметры

строка $option
Ключ опции.
смешанное $value
Значение опции.

Возвращает

Cake\ORM\SaveOptionsBuilder

toArray()source public

toArray( )

Возвращает

массив

validate()source public

validate( string $validate )

Устанавливает набор правил валидации.

Параметры

строка $validate
Имя набора правил валидации.

Возвращает

Cake\ORM\SaveOptionsBuilder

Методы, используемые из Cake\ORM\AssociationsNormalizerTrait

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

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

Параметры

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

Возвращает

массив
Массив, в котором обозначение точкой преобразованно в вложенные массивы

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

$_optionssource

protected массив

Опции

[]
END_OF_DOCUMENT_MARKER

$_tablesource

protected Cake\ORM\Table

Объект таблицы.

© 2005–2017 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.4/class-Cake.ORM.SaveOptionsBuilder.html

Spec-Zone.ru

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