Spec-Zone.ru › Laravel 10

Модель

абстрактный класс Модель реализует Arrayable, ArrayAccess, CanBeEscapedWhenCastToString, HasBroadcastChannel, Jsonable, JsonSerializable, QueueableEntity, UrlRoutable (Просмотреть исходный код)

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HasUniqueIds
HidesAttributes
GuardsAttributes
ForwardsCalls

Константы

CREATED_AT

Имя столбца "создано в".

UPDATED_AT

Имя столбца "обновлено в".

Свойства

protected массив $attributes

Атрибуты модели.

из HasAttributes
protected массив $original

Исходное состояние атрибутов модели.

из HasAttributes
protected массив $changes

Изменённые атрибуты модели.

из HasAttributes
protected массив $casts

Атрибуты, которые должны быть преобразованы.

из HasAttributes
protected массив $classCastCache

Атрибуты, которые были преобразованы с помощью пользовательских классов.

из HasAttributes
protected массив $attributeCastCache

Атрибуты, которые были преобразованы с использованием мутаторов типа возвращаемого значения «Атрибут».

из HasAttributes
static protected строка[] $primitiveCastTypes

Встроенные, примитивные типы преобразований, поддерживаемые Eloquent.

из HasAttributes
protected строка $dateFormat

Формат хранения столбцов даты модели.

из HasAttributes
protected массив $appends

Доступные методы для добавления в массивную форму модели.

из HasAttributes
static bool $snakeAttributes

Указывает, преобразуются ли атрибуты в змеиный регистр в массивах.

из HasAttributes
static protected массив $mutatorCache

Кэш изменённых атрибутов для каждого класса.

из HasAttributes
static protected массив $attributeMutatorCache

Кэш атрибутов, помеченных мутаторами типа возвращаемого значения «Атрибут», для каждого класса.

из HasAttributes
static protected массив $getAttributeMutatorCache

Кэш атрибутов, помеченных мутаторами типа возвращаемого значения «Атрибут», которые можно получить для каждого класса.

из HasAttributes
static protected массив $setAttributeMutatorCache

Кэш атрибутов, помеченных мутаторами типа возвращаемого значения «Атрибут», которые можно установить для каждого класса.

из HasAttributes
static protected массив $castTypeCache

Кэш преобразованных типов преобразования.

из HasAttributes
static Encrypter|null $encrypter

Экземпляр шифровальщика, используемый для шифрования атрибутов.

из HasAttributes
protected массив $dispatchesEvents

Карта событий для модели.

из HasEvents
protected массив $observables

События, доступные пользователю.

из HasEvents
protected массив $relations

Загруженные отношения для модели.

из HasRelationships
protected массив $touches

Отношения, которые должны быть изменены при сохранении.

из HasRelationships
static строка[] $manyMethods

Методы отношений "многие ко многим".

из HasRelationships
static protected массив $relationResolvers

Обратные вызовы для разрешения отношений.

из HasRelationships
bool $timestamps

Указывает, нужно ли добавлять метки времени к модели.

из HasTimestamps
static protected массив $ignoreTimestampsOn

Список классов моделей, у которых метки времени временно отключены.

из HasTimestamps
bool $usesUniqueIds

Указывает, использует ли модель уникальные идентификаторы.

из HasUniqueIds
protected строка[] $hidden

Атрибуты, которые нужно скрывать при сериализации.

из HidesAttributes
protected строка[] $visible

Атрибуты, которые нужно отображать при сериализации.

из HidesAttributes
protected массив<int,строка> $fillable

Атрибуты, которые можно задавать массово.

из GuardsAttributes
protected строка[]|bool $guarded

Атрибуты, которые нельзя задавать массово.

из GuardsAttributes
static protected bool $unguarded

Указывает, разрешена ли массовая присваивание всех атрибутов.

из GuardsAttributes
static protected строка[] $guardableColumns

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

из GuardsAttributes
protected строка|null $connection

Имя подключения для модели.

protected строка $table

Таблица, связанная с моделью.

protected строка $primaryKey

Первичный ключ для модели.

protected строка $keyType

Тип первичного ключа.

bool $incrementing

Указывает, являются ли идентификаторы автоинкрементными.

protected массив $with

Отношения, которые нужно загрузить с помощью eager loading при каждом запросе.

protected array $withCount

Счетчики отношений, которые должны быть загружены жадно при каждом запросе.

bool $preventsLazyLoading

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

protected int $perPage

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

bool $exists

Указывает, существует ли модель.

bool $wasRecentlyCreated

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

protected bool $escapeWhenCastingToString

Указывает, что строковое представление объекта должно быть экранировано при вызове __toString.

static protected ConnectionResolverInterface $resolver

Экземпляр решателя соединения.

static protected Dispatcher $dispatcher

Экземпляр диспетчера событий.

static protected array $booted

Массив запущенных моделей.

static protected array $traitInitializers

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

static protected array $globalScopes

Массив глобальных ограничений модели.

static protected array $ignoreOnTouch

Список классов моделей, которые не должны затрагиваться методом touch.

static protected bool $modelsShouldPreventLazyLoading

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

static protected callable|null $lazyLoadingViolationCallback

Обратный вызов, ответственный за обработку нарушений ленивой загрузки.

static protected bool $modelsShouldPreventSilentlyDiscardingAttributes

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

static protected callable|null $discardedAttributeViolationCallback

Обратный вызов, ответственный за обработку нарушений при удалении атрибутов.

static protected bool $modelsShouldPreventAccessingMissingAttributes

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

static protected callable|null $missingAttributeViolationCallback

Обратный вызов, ответственный за обработку нарушений при обращении к отсутствующим атрибутам.

static protected bool $isBroadcasting

Указывает, включено ли вещание в данный момент.

Методы

массив attributesToArray()

Преобразовать атрибуты модели в массив.

из HasAttributes
массив addDateAttributesToArray(массив $attributes)

Добавить атрибуты даты в массив атрибутов.

из HasAttributes
массив addMutatedAttributesToArray(массив $attributes, массив $mutatedAttributes)

Добавить изменённые атрибуты в массив атрибутов.

из HasAttributes
массив addCastAttributesToArray(массив $attributes, массив $mutatedAttributes)

Добавить атрибуты с преобразованием в массив атрибутов.

из HasAttributes
массив getArrayableAttributes()

Получить массив всех преобразоваемых в массив атрибутов.

из HasAttributes
массив getArrayableAppends()

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

из HasAttributes
массив relationsToArray()

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

из HasAttributes
массив getArrayableRelations()

Получить массив всех преобразоваемых в массив отношений.

из HasAttributes
массив getArrayableItems(массив $values)

Получить массив всех преобразоваемых в массив значений.

из HasAttributes
смешанный тип getAttribute(строка $key)

Получить атрибут из модели.

из HasAttributes
null throwMissingAttributeExceptionIfApplicable(строка $key)

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

из HasAttributes
смешанный тип getAttributeValue(строка $key)

Получить простой атрибут (не отношение).

из HasAttributes
смешанный тип getAttributeFromArray(строка $key)

Получить атрибут из массива $attributes.

из HasAttributes
смешанный тип getRelationValue(строка $key)

Получить отношение.

из HasAttributes
логическое значение isRelation(строка $key)

Определить, является ли данный ключ методом отношения в модели.

из HasAttributes
смешанный тип handleLazyLoadingViolation(строка $key)

Обработать нарушение леничной загрузки.

из HasAttributes
смешанный тип getRelationshipFromMethod(строка $method)

Получить значение отношения из метода.

из HasAttributes
логическое значение hasGetMutator(строка $key)

Определить, существует ли мутатор get для атрибута.

из HasAttributes
логическое значение hasAttributeMutator(строка $key)

Определить, существует ли мутатор для атрибута типа "Атрибут".

из HasAttributes
логическое значение hasAttributeGetMutator(строка $key)

Определить, существует ли мутатор get для атрибута типа "Атрибут".

из HasAttributes
смешанный тип mutateAttribute(строка $key, смешанный тип $value)

Получить значение атрибута с помощью его мутатора.

из HasAttributes
смешанный тип mutateAttributeMarkedAttribute(строка $key, смешанный тип $value)

Получить значение атрибута типа "Атрибут" с помощью его мутатора.

из HasAttributes
смешанный тип mutateAttributeForArray(строка $key, смешанный тип $value)

Получить значение атрибута с помощью его мутатора для преобразования в массив.

из HasAttributes
$this mergeCasts(массив $casts)

Объединить новые преобразования с существующими преобразованиями модели.

из HasAttributes
смешанный тип castAttribute(строка $key, смешанный тип $value)

Преобразовать атрибут в стандартный тип PHP.

из HasAttributes
смешанный тип getClassCastableAttributeValue(строка $key, смешанный тип $value)

Преобразовать атрибут с помощью пользовательского класса преобразования.

из HasAttributes
смешанный тип getEnumCastableAttributeValue(строка $key, смешанный тип $value)

Преобразовать атрибут в перечисление.

из HasAttributes
строка getCastType(строка $key)

Получить тип преобразования для атрибута модели.

из HasAttributes
mixed deviateClassCastableAttribute(string $method, string $key, mixed $value)

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

from HasAttributes
mixed serializeClassCastableAttribute(string $key, mixed $value)

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

from HasAttributes
bool isCustomDateTimeCast(string $cast)

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

from HasAttributes
bool isImmutableCustomDateTimeCast(string $cast)

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

from HasAttributes
bool isDecimalCast(string $cast)

Определить, является ли тип преобразования десятичным преобразованием.

from HasAttributes
mixed setAttribute(string $key, mixed $value)

Установить заданный атрибут в модели.

from HasAttributes
bool hasSetMutator(string $key)

Определить, существует ли мутатор установки для атрибута.

from HasAttributes
bool hasAttributeSetMutator(string $key)

Определить, существует ли мутатор установки для атрибута с типом возвращаемого значения "Attribute".

from HasAttributes
mixed setMutatedAttributeValue(string $key, mixed $value)

Установить значение атрибута с использованием его мутатора.

from HasAttributes
mixed setAttributeMarkedMutatedAttributeValue(string $key, mixed $value)

Установить значение атрибута с типом возвращаемого значения "Attribute" с использованием его мутатора.

from HasAttributes
bool isDateAttribute(string $key)

Определить, является ли заданный атрибут датой или преобразуемым в дату.

from HasAttributes
$this fillJsonAttribute(string $key, mixed $value)

Установить заданный JSON атрибут в модели.

from HasAttributes
void setClassCastableAttribute(string $key, mixed $value)

Установить значение атрибута с преобразованием в класс.

from HasAttributes
void setEnumCastableAttribute(string $key, UnitEnum|string|int $value)

Установить значение атрибута с преобразованием в перечисление.

from HasAttributes
UnitEnum|BackedEnum getEnumCaseFromValue(string $enumClass, string|int $value)

Получить экземпляр перечисления по заданному классу и значению.

from HasAttributes
string|int getStorableEnumValue(UnitEnum|BackedEnum $value)

Получить сохраняемое значение из заданного перечисления.

from HasAttributes
$this getArrayAttributeWithValue(string $path, string $key, mixed $value)

Получить атрибут массива с заданным ключом и установленным значением.

from HasAttributes
array getArrayAttributeByKey(string $key)

Получить атрибут массива или вернуть пустой массив, если он не установлен.

from HasAttributes
string castAttributeAsJson(string $key, mixed $value)

Преобразовать заданный атрибут в JSON.

from HasAttributes
string asJson(mixed $value)

Кодировать заданное значение в JSON.

from HasAttributes
mixed fromJson(string $value, bool $asObject = false)

Декодировать заданный JSON в массив или объект.

from HasAttributes
mixed fromEncryptedString(string $value)

Расшифровать заданную зашифрованную строку.

from HasAttributes
string castAttributeAsEncryptedString(string $key, mixed $value)

Преобразовать заданный атрибут в зашифрованную строку.

from HasAttributes
static void encryptUsing(Encrypter|null $encrypter)

Установить экземпляр шифратора, который будет использоваться для шифрования атрибутов.

from HasAttributes
string castAttributeAsHashedString(string $key, mixed $value)

Преобразовать заданный атрибут в хешированную строку.

from HasAttributes
mixed fromFloat(mixed $value)

Декодировать заданное значение с плавающей точкой.

from HasAttributes
string asDecimal(float|string $value, int $decimals)

Возвратить десятичное значение в виде строки.

from HasAttributes
Carbon asDate(mixed $value)

Возвращает метку времени в виде объекта DateTime со временем, установленным на 00:00:00.

from HasAttributes
Carbon asDateTime(mixed $value)

Возвращает метку времени в виде объекта DateTime.

from HasAttributes
bool isStandardDateFormat(string $value)

Определяет, является ли заданное значение стандартным форматом даты.

from HasAttributes
string|null fromDateTime(mixed $value)

Преобразует DateTime в строку для хранения.

from HasAttributes
int asTimestamp(mixed $value)

Возвращает метку времени в виде unix timestamp.

from HasAttributes
string serializeDate(DateTimeInterface $date)

Подготавливает дату для сериализации массива / JSON.

from HasAttributes
array getDates()

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

from HasAttributes
string getDateFormat()

Получает формат для дат, хранящихся в базе данных.

from HasAttributes
$this setDateFormat(string $format)

Устанавливает формат даты, используемый моделью.

from HasAttributes
bool hasCast(string $key, array|string|null $types = null)

Определяет, следует ли преобразовывать атрибут в собственный тип.

from HasAttributes
array getCasts()

Получает массив преобразований.

from HasAttributes
bool isDateCastable(string $key)

Определяет, можно ли преобразовать значение в Date / DateTime для входящей обработки.

from HasAttributes
bool isDateCastableWithCustomFormat(string $key)

Определяет, можно ли преобразовать значение в Date / DateTime с пользовательским преобразованием для входящей обработки.

from HasAttributes
bool isJsonCastable(string $key)

Определяет, можно ли преобразовать значение в JSON для входящей обработки.

from HasAttributes
bool isEncryptedCastable(string $key)

Определяет, является ли значение шифруемым для входящей обработки.

from HasAttributes
bool isClassCastable(string $key)

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

from HasAttributes
bool isEnumCastable(string $key)

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

from HasAttributes
bool isClassDeviable(string $key)

Определяет, можно ли изменять ключ с использованием пользовательского класса.

from HasAttributes
bool isClassSerializable(string $key)

Определяет, можно ли сериализовать ключ с использованием пользовательского класса.

from HasAttributes
mixed resolveCasterClass(string $key)

Определяет пользовательский класс преобразователя для заданного ключа.

from HasAttributes
string parseCasterClass(string $class)

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

from HasAttributes
void mergeAttributesFromCachedCasts()

Сливает атрибуты класса преобразования и атрибуты преобразования атрибутов обратно в модель.

from HasAttributes
void mergeAttributesFromClassCasts()

Сливает атрибуты класса преобразования обратно в модель.

from HasAttributes
void mergeAttributesFromAttributeCasts()

Сливает атрибуты класса преобразования обратно в модель.

from HasAttributes
array normalizeCastClassResponse(string $key, mixed $value)

Нормализует ответ от пользовательского класса преобразователя.

from HasAttributes
array getAttributes()

Получает все текущие атрибуты модели.

from HasAttributes
array getAttributesForInsert()

Получает все текущие атрибуты модели для операции вставки.

from HasAttributes
$this setRawAttributes(array $attributes, bool $sync = false)

Устанавливает массив атрибутов модели. Проверка не выполняется.

from HasAttributes
mixed|array getOriginal(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели.

из HasAttributes
mixed|array getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели.

из HasAttributes
mixed|array getRawOriginal(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели в сыром виде.

из HasAttributes
array only(array|mixed $attributes)

Получить подмножество атрибутов модели.

из HasAttributes
$this syncOriginal()

Синхронизировать исходные атрибуты с текущими.

из HasAttributes
$this syncOriginalAttribute(string $attribute)

Синхронизировать один исходный атрибут со своим текущим значением.

из HasAttributes
$this syncOriginalAttributes(array|string $attributes)

Синхронизировать несколько исходных атрибутов со своими текущими значениями.

из HasAttributes
$this syncChanges()

Синхронизировать измененные атрибуты.

из HasAttributes
bool isDirty(array|string|null $attributes = null)

Определить, была ли изменена модель или какой-либо из заданных атрибутов.

из HasAttributes
bool isClean(array|string|null $attributes = null)

Определить, осталась ли модель или все заданные атрибуты неизменными.

из HasAttributes
$this discardChanges()

Отбросить изменения атрибутов и сбросить атрибуты до исходного состояния.

из HasAttributes
bool wasChanged(array|string|null $attributes = null)

Определить, была ли модель или какой-либо из заданных атрибутов изменена при последнем сохранении модели.

из HasAttributes
bool hasChanges(array $changes, array|string|null $attributes = null)

Определить, были ли изменены какие-либо из заданных атрибутов при последнем сохранении модели.

из HasAttributes
array getDirty()

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

из HasAttributes
array getDirtyForUpdate()

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

из HasAttributes
array getChanges()

Получить атрибуты, которые были изменены при последнем сохранении модели.

из HasAttributes
bool originalIsEquivalent(string $key)

Определить, эквивалентны ли новые и старые значения для данного ключа.

из HasAttributes
mixed transformModelValue(string $key, mixed $value)

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

из HasAttributes
$this append(array|string $attributes)

Добавить атрибуты к запросу при построении запроса.

из HasAttributes
array getAppends()

Получить аксессоры, которые добавляются к массивам модели.

из HasAttributes
$this setAppends(array $appends)

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

из HasAttributes
bool hasAppended(string $attribute)

Возвращает, был ли аксессор атрибута добавлен.

из HasAttributes
array getMutatedAttributes()

Получить изменённые атрибуты для данного экземпляра.

из HasAttributes
static void cacheMutatedAttributes(object|string $classOrInstance)

Извлечь и кэшировать все изменённые атрибуты класса.

из HasAttributes
static array getMutatorMethods(mixed $class)

Получить все методы мутаторов атрибутов.

из HasAttributes
static array getAttributeMarkedMutatorMethods(mixed $class)

Получить все методы мутаторов атрибутов с возвращаемым типом "Атрибут".

из HasAttributes
static void bootHasEvents()

Инициализировать трайт has events для модели.

из HasEvents
static array resolveObserveAttributes()

Разрешить имена классов наблюдения из атрибутов.

из HasEvents
static void observe(object|array|string $classes)

Зарегистрировать наблюдателей для модели.

из HasEvents
void registerObserver(object|string $class)

Зарегистрировать одиночный наблюдатель с моделью.

from HasEvents
array getObservableEvents()

Получить имена наблюдаемых событий.

from HasEvents
$this setObservableEvents(array $observables)

Установить имена наблюдаемых событий.

from HasEvents
void addObservableEvents(array|mixed $observables)

Добавить имя наблюдаемого события.

from HasEvents
void removeObservableEvents(array|mixed $observables)

Удалить имя наблюдаемого события.

from HasEvents
static void registerModelEvent(string $event, QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие модели с диспетчером.

from HasEvents
mixed fireModelEvent(string $event, bool $halt = true)

Вызвать заданное событие для модели.

from HasEvents
mixed|null fireCustomModelEvent(string $event, string $method)

Вызвать пользовательское событие модели для заданного события.

from HasEvents
mixed filterModelEventResults(mixed $result)

Отфильтровать результаты события модели.

from HasEvents
static void retrieved(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие извлечения модели с диспетчером.

from HasEvents
static void saving(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие сохранения модели с диспетчером.

from HasEvents
static void saved(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие сохраненной модели с диспетчером.

from HasEvents
static void updating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие обновления модели с диспетчером.

from HasEvents
static void updated(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие обновленной модели с диспетчером.

from HasEvents
static void creating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие создания модели с диспетчером.

from HasEvents
static void created(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие созданной модели с диспетчером.

from HasEvents
static void replicating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие репликации модели с диспетчером.

from HasEvents
static void deleting(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие удаления модели с диспетчером.

from HasEvents
static void deleted(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие удаленной модели с диспетчером.

from HasEvents
static void flushEventListeners()

Удалить все обработчики событий для модели.

from HasEvents
static Dispatcher getEventDispatcher()

Получить экземпляр диспетчера событий.

from HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

Установить экземпляр диспетчера событий.

from HasEvents
static void unsetEventDispatcher()

Сбросить диспетчер событий для моделей.

from HasEvents
static mixed withoutEvents(callable $callback)

Выполнить обратный вызов без вызова каких-либо событий модели для любого типа модели.

from HasEvents
static void bootHasGlobalScopes()

Загрузить черту has global scopes для модели.

from HasGlobalScopes
static array resolveGlobalScopeAttributes()

Разрешить имена классов глобальной области видимости из атрибутов.

from HasGlobalScopes
static mixed addGlobalScope(Scope|Closure|string $scope, Scope|Closure|null $implementation = null)

Зарегистрировать новую глобальную область видимости в модели.

from HasGlobalScopes
static void addGlobalScopes(array $scopes)

Зарегистрировать несколько глобальных областей видимости в модели.

from HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

Определить, имеет ли модель глобальную область видимости.

from HasGlobalScopes
static Scope|Closure|null getGlobalScope(Scope|string $scope)

Получить глобальную область видимости, зарегистрированную в модели.

from HasGlobalScopes
static array getAllGlobalScopes()

Получить все глобальные области видимости, которые в настоящее время зарегистрированы.

from HasGlobalScopes
static void setAllGlobalScopes(array $scopes)

Установить текущие глобальные области видимости.

from HasGlobalScopes
array getGlobalScopes()

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

from HasGlobalScopes
mixed relationResolver(string $class, string $key)

Получить решатель динамических отношений, если он определен или унаследован, или вернуть null.

from HasRelationships
static void resolveRelationUsing(string $name, Closure $callback)

Определить решатель динамических отношений.

from HasRelationships
HasOne hasOne(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определить отношение «один-к-одному».

from HasRelationships
HasOne newHasOne(Builder $query, Model $parent, string $foreignKey, string $localKey)

Создать новое отношение HasOne.

from HasRelationships
HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение «один-через-один».

from HasRelationships
HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Создать новое отношение HasOneThrough.

from HasRelationships
MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определить полиморфное отношение «один-к-одному».

from HasRelationships
MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Создать новое отношение MorphOne.

from HasRelationships
BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

Определить обратное отношение «один-к-одному» или «многие-к-одному».

from HasRelationships
BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Создать новое отношение BelongsTo.

from HasRelationships
MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному».

from HasRelationships
MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)

Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному».

from HasRelationships
MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

Определить полиморфное, обратное отношение «один-к-одному» или «многие-к-одному».

from HasRelationships
MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

Создать новое отношение MorphTo.

from HasRelationships
static string getActualClassNameForMorph(string $class)

Получить фактическое имя класса для заданного класса morph.

from HasRelationships
string guessBelongsToRelation()

Угадать имя отношения "belongs to".

from HasRelationships
PendingHasThroughRelationship through(string|HasMany|HasOne $relationship)

Создать ожидаемое отношение has-many-through или has-one-through.

from HasRelationships
HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определить отношение один-ко-многим.

from HasRelationships
HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Создать новое отношение HasMany.

from HasRelationships
HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение has-many-through.

from HasRelationships
HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Создать новое отношение HasManyThrough.

from HasRelationships
MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определить полиморфное отношение один-ко-многим.

from HasRelationships
MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Создать новое отношение MorphMany.

from HasRelationships
BelongsToMany belongsToMany(string $related, string|Model>|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определить отношение многие-ко-многим.

from HasRelationships
BelongsToMany newBelongsToMany(Builder $query, Model $parent, string|Model> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Создать новое отношение BelongsToMany.

from HasRelationships
MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null, bool $inverse = false)

Определить полиморфное отношение многие-ко-многим.

from HasRelationships
MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Создать новое отношение MorphToMany.

from HasRelationships
MorphToMany morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определить полиморфное обратное отношение многие-ко-многим.

from HasRelationships
string|null guessBelongsToManyRelation()

Получить имя отношения belongsToMany.

from HasRelationships
string joiningTable(string $related, Model|null $instance = null)

Получить имя таблицы объединения для отношения многие-ко-многим.

from HasRelationships
string joiningTableSegment()

Получить часть имени промежуточной таблицы для отношений belongsToMany от текущей модели.

from HasRelationships
bool touches(string $relation)

Определить, затрагивает ли модель заданное отношение.

from HasRelationships
void touchOwners()

Обновить метку времени для отношений владения модели.

from HasRelationships
array getMorphs(string $name, string $type, string $id)

Получить колонки полиморфных отношений.

from HasRelationships
string getMorphClass()

Получить имя класса для полиморфных отношений.

from HasRelationships
mixed newRelatedInstance(string $class)

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

from HasRelationships
mixed newRelatedThroughInstance(string $class)

Создать новый экземпляр модели для связанной модели через "через" модель.

from HasRelationships
array getRelations()

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

from HasRelationships
mixed getRelation(string $relation)

Получить указанное отношение.

from HasRelationships
bool relationLoaded(string $key)

Определить, загружено ли данное отношение.

from HasRelationships
$this setRelation(string $relation, mixed $value)

Установить заданное отношение для модели.

from HasRelationships
$this unsetRelation(string $relation)

Удалить загруженное отношение.

from HasRelationships
$this setRelations(array $relations)

Установить весь массив отношений для модели.

from HasRelationships
$this withoutRelations()

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

from HasRelationships
$this unsetRelations()

Удалить все загруженные отношения для экземпляра.

from HasRelationships
array getTouchedRelations()

Получить отношения, которые обновляются при сохранении.

from HasRelationships
$this setTouchedRelations(array $touches)

Установить отношения, которые обновляются при сохранении.

from HasRelationships
bool touch(string|null $attribute = null)

Обновить метку времени обновления модели.

from HasTimestamps
bool touchQuietly(string|null $attribute = null)

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

from HasTimestamps
$this updateTimestamps()

Обновить метки времени создания и обновления.

from HasTimestamps
$this setCreatedAt(mixed $value)

Установить значение атрибута "created at".

from HasTimestamps
$this setUpdatedAt(mixed $value)

Установить значение атрибута "updated at".

from HasTimestamps
Carbon freshTimestamp()

Получить свежую метку времени для модели.

from HasTimestamps
string freshTimestampString()

Получить свежую метку времени для модели.

from HasTimestamps
bool usesTimestamps()

Определить, использует ли модель метки времени.

from HasTimestamps
string|null getCreatedAtColumn()

Получить имя колонки "created at".

from HasTimestamps
string|null getUpdatedAtColumn()

Получить имя колонки "updated at".

from HasTimestamps
string|null getQualifiedCreatedAtColumn()

Получить полностью квалифицированную колонку "created at".

from HasTimestamps
string|null getQualifiedUpdatedAtColumn()

Получить полностью квалифицированную колонку "updated at".

from HasTimestamps
static mixed withoutTimestamps(callable $callback)

Отключить метки времени для текущего класса во время выполнения данного обратного вызова.

from HasTimestamps
static mixed withoutTimestampsOn(array $models, callable $callback)

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

from HasTimestamps
static bool isIgnoringTimestamps(string|null $class = null)

Определить, игнорирует ли данная модель отметки времени / касания.

from HasTimestamps
bool usesUniqueIds()

Определить, использует ли модель уникальные идентификаторы.

from HasUniqueIds
void setUniqueIds()

Генерировать уникальные ключи для модели.

from HasUniqueIds
string newUniqueId()

Сгенерировать новый ключ для модели.

from HasUniqueIds
array uniqueIds()

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

from HasUniqueIds
string[] getHidden()

Получить скрытые атрибуты модели.

from HidesAttributes
$this setHidden(array $hidden)

Установить скрытые атрибуты модели.

from HidesAttributes
string[] getVisible()

Получить видимые атрибуты модели.

from HidesAttributes
$this setVisible(array $visible)

Установить видимые атрибуты для модели.

from HidesAttributes
$this makeVisible(string[]|string|null $attributes)

Сделать заданные, обычно скрытые, атрибуты видимыми.

from HidesAttributes
$this makeVisibleIf(bool|Closure $condition, string[]|string|null $attributes)

Сделать заданные, обычно скрытые, атрибуты видимыми, если заданное истинное условие выполняется.

from HidesAttributes
$this makeHidden(string[]|string|null $attributes)

Сделать заданные, обычно видимые, атрибуты скрытыми.

from HidesAttributes
$this makeHiddenIf(bool|Closure $condition, string[]|string|null $attributes)

Сделать заданные, обычно видимые, атрибуты скрытыми, если заданное истинное условие выполняется.

from HidesAttributes
string[] getFillable()

Получить заполняемые атрибуты модели.

from GuardsAttributes
$this fillable(array $fillable)

Установить заполняемые атрибуты для модели.

from GuardsAttributes
$this mergeFillable(array $fillable)

Объединить новые заполняемые атрибуты с существующими заполняемыми атрибутами модели.

from GuardsAttributes
string[] getGuarded()

Получить защищённые атрибуты модели.

from GuardsAttributes
$this guard(array $guarded)

Установить защищённые атрибуты для модели.

from GuardsAttributes
$this mergeGuarded(array $guarded)

Объединить новые защищённые атрибуты с существующими защищёнными атрибутами модели.

from GuardsAttributes
static void unguard(bool $state = true)

Отключить все ограничения массового назначения.

from GuardsAttributes
static void reguard()

Включить ограничения массового назначения.

from GuardsAttributes
static bool isUnguarded()

Определить, является ли текущее состояние "без защиты".

from GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов, будучи без защиты.

from GuardsAttributes
bool isFillable(string $key)

Определить, может ли данный атрибут быть назначен массово.

from GuardsAttributes
bool isGuarded(string $key)

Определить, является ли данный ключ защищённым.

from GuardsAttributes
bool isGuardableColumn(string $key)

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

from GuardsAttributes
bool totallyGuarded()

Определить, является ли модель полностью защищенной.

from GuardsAttributes
array fillableFromArray(array $attributes)

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

from GuardsAttributes
mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода заданному объекту.

from ForwardsCalls
mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

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

from ForwardsCalls
static void throwBadMethodCallException(string $method)

Выбросить исключение о неверном вызове метода для заданного метода.

from ForwardsCalls
void __construct(array $attributes = [])

Создать новый экземпляр модели Eloquent.

void bootIfNotBooted()

Проверить, нужно ли загрузить модель и, если да, сделать это.

static void booting()

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

static void boot()

Загрузить модель и её черты.

static void bootTraits()

Загрузить все загружаемые черты модели.

void initializeTraits()

Инициализировать все инициализируемые черты модели.

static void booted()

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

static void clearBootedModels()

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

static void withoutTouching(callable $callback)

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

static void withoutTouchingOn(array $models, callable $callback)

Отключает касание модели отношений для заданных классов моделей в пределах области действия обратного вызова.

static bool isIgnoringTouch(string|null $class = null)

Определить, игнорирует ли заданная модель касания.

static void shouldBeStrict(bool $shouldBeStrict = true)

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

static void preventLazyLoading(bool $value = true)

Предотвратить ленивую загрузку отношений модели.

static void handleLazyLoadingViolationUsing(callable|null $callback)

Зарегистрировать обратный вызов, ответственный за обработку нарушений ленивой загрузки.

static void preventSilentlyDiscardingAttributes(bool $value = true)

Предотвратить молчаливое отбрасывание незаполняемых атрибутов.

static void handleDiscardedAttributeViolationUsing(callable|null $callback)

Зарегистрировать обратный вызов, ответственный за обработку нарушений отбрасывания атрибутов.

static void preventAccessingMissingAttributes(bool $value = true)

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

static void handleMissingAttributeViolationUsing(callable|null $callback)

Зарегистрировать обратный вызов, ответственный за обработку нарушений доступа к отсутствующим атрибутам.

static mixed withoutBroadcasting(callable $callback)

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

$this fill(array $attributes)

Заполнить модель массивом атрибутов.

$this forceFill(array $attributes)

Заполнить модель массивом атрибутов. Принудительное массовое присваивание.

string qualifyColumn(string $column)

Квалифицировать заданное имя столбца таблицей модели.

array qualifyColumns(array $columns)

Квалифицировать заданные столбцы таблицей модели.

Model newInstance(array $attributes = [], bool $exists = false)

Создать новый экземпляр заданной модели.

Model newFromBuilder(array $attributes = [], string|null $connection = null)

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

static Builder on(string|null $connection = null)

Начать запрос модели на заданном соединении.

static Builder onWriteConnection()

Начать запрос модели на соединении записи.

static Collection<int,static> all(array|string $columns = ['*'])

Получить все модели из базы данных.

static Builder with(array|string $relations)

Начать запрос модели с загрузкой.

$this load(array|string $relations)

Загрузить отношения модели.

$this loadMorph(string $relation, array $relations)

Загрузить отношения на полиморфном отношении модели.

$this loadMissing(array|string $relations)

Загрузить отношения модели, если они ещё не загружены.

$this loadAggregate(array|string $relations, string $column, string|null $function = null)

Загрузить агрегации столбцов отношений модели.

$this loadCount(array|string $relations)

Загрузить подсчёты отношений модели.

$this loadMax(array|string $relations, string $column)

Загрузить максимальные значения столбцов отношений модели.

$this loadMin(array|string $relations, string $column)

Загрузить минимальные значения столбцов отношений модели.

$this loadSum(array|string $relations, string $column)

Загрузить суммирования столбцов отношений модели.

$this loadAvg(array|string $relations, string $column)

Загрузить средние значения столбцов отношений модели.

$this loadExists(array|string $relations)

Загрузить значения существования связанных моделей.

$this loadMorphAggregate(string $relation, array $relations, string $column, string|null $function = null)

Загрузить агрегацию столбцов отношений на полиморфном отношении модели.

$this loadMorphCount(string $relation, array $relations)

Загрузка подсчёта отношений по полиморфному отношению модели.

$this loadMorphMax(string $relation, array $relations, string $column)

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

$this loadMorphMin(string $relation, array $relations, string $column)

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

$this loadMorphSum(string $relation, array $relations, string $column)

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

$this loadMorphAvg(string $relation, array $relations, string $column)

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

int increment(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.

int decrement(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.

int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Выполнить метод увеличения или уменьшения значения столбца модели.

bool update(array $attributes = [], array $options = [])

Обновить модель в базе данных.

bool updateOrFail(array $attributes = [], array $options = [])

Обновить модель в базе данных в рамках транзакции.

bool updateQuietly(array $attributes = [], array $options = [])

Обновить модель в базе данных без срабатывания событий.

int incrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество без срабатывания событий.

int decrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество без срабатывания событий.

bool push()

Сохранить модель и все её отношения.

bool pushQuietly()

Сохранить модель и все её отношения без срабатывания событий родительской модели.

bool saveQuietly(array $options = [])

Сохранить модель в базе данных без срабатывания событий.

bool save(array $options = [])

Сохранить модель в базе данных.

bool saveOrFail(array $options = [])

Сохранить модель в базе данных в рамках транзакции.

void finishSave(array $options)

Выполнить необходимые действия после сохранения модели.

bool performUpdate(Builder $query)

Выполнить операцию обновления модели.

Builder setKeysForSelectQuery(Builder $query)

Установить ключи для запроса выборки.

mixed getKeyForSelectQuery()

Получить значение первичного ключа для запроса выборки.

Builder setKeysForSaveQuery(Builder $query)

Установить ключи для запроса сохранения обновления.

mixed getKeyForSaveQuery()

Получить значение первичного ключа для запроса сохранения.

bool performInsert(Builder $query)

Выполнить операцию вставки модели.

void insertAndSetId(Builder $query, array $attributes)

Вставить заданные атрибуты и установить ID модели.

static int destroy(Collection|array|int|string $ids)

Удалить модели для заданных ID.

bool|null delete()

Удалить модель из базы данных.

bool deleteQuietly()

Удалить модель из базы данных без срабатывания событий.

bool|null deleteOrFail()

Удалить модель из базы данных в рамках транзакции.

bool|null forceDelete()

Выполнить жёсткое удаление мягко удалённой модели.

void performDeleteOnModel()

Выполнить фактический запрос удаления по этому экземпляру модели.

static Builder query()

Начать создание запроса к модели.

Builder newQuery()

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

Builder|Model newModelQuery()

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

Builder newQueryWithoutRelationships()

Получить новый билдер запроса без загрузки отношений.

Builder registerGlobalScopes(Builder $builder)

Зарегистрировать глобальные ограничения для этого экземпляра билдера.

Builder|Model newQueryWithoutScopes()

Получить новый билдер запроса без глобальных ограничений.

Builder newQueryWithoutScope(Scope|string $scope)

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

Builder newQueryForRestoration(array|int $ids)

Получить новый запрос для восстановления одной или нескольких моделей по их идентификаторам очереди.

Builder|Модель newEloquentBuilder(Builder $query)

Создать новый Eloquent-запрос для модели.

Builder newBaseQueryBuilder()

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

Коллекция newCollection(array $models = [])

Создать новый экземпляр Eloquent Collection.

Связь newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)

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

bool hasNamedScope(string $scope)

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

mixed callNamedScope(string $scope, array $parameters = [])

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

toArray()

Преобразовать экземпляр модели в массив.

string toJson(int $options = 0)

Преобразовать экземпляр модели в JSON.

mixed jsonSerialize()

Преобразовать объект в сериализуемый в JSON формат.

Модель|null fresh(array|string $with = [])

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

$this refresh()

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

Модель replicate(array $except = null)

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

Модель replicateQuietly(array $except = null)

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

bool is(Модель|null $model)

Определить, имеют ли две модели одинаковый ID и относятся к одной таблице.

bool isNot(Модель|null $model)

Определить, не являются ли две модели одинаковыми.

Подключение getConnection()

Получить подключение к базе данных для модели.

string|null getConnectionName()

Получить имя текущего подключения для модели.

$this setConnection(string|null $name)

Установить подключение, связанное с моделью.

static Подключение resolveConnection(string|null $connection = null)

Разрешить экземпляр подключения.

static Интерфейс разрешения подключения|null getConnectionResolver()

Получить экземпляр разрешителя подключения.

static void setConnectionResolver(Интерфейс разрешения подключения $resolver)

Установить экземпляр разрешителя подключения.

static void unsetConnectionResolver()

Удалить разрешитель подключения для моделей.

string getTable()

Получить таблицу, связанную с моделью.

$this setTable(string $table)

Установить таблицу, связанную с моделью.

string getKeyName()

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

$this setKeyName(string $key)

Установить первичный ключ для модели.

string getQualifiedKeyName()

Получить квалифицированное имя первичного ключа.

string getKeyType()

Получить тип автоинкрементируемого ключа.

$this setKeyType(string $type)

Установить тип данных для первичного ключа.

bool getIncrementing()

Получить значение, указывающее, являются ли ID инкрементируемыми.

$this setIncrementing(bool $value)

Установить, являются ли ID инкрементируемыми.

mixed getKey()

Получить значение первичного ключа модели.

mixed getQueueableId()

Получить идентификатор для очереди выполнения.

array getQueueableRelations()

Получить связи для очереди выполнения.

string|null getQueueableConnection()

Получить подключение для очереди выполнения.

mixed getRouteKey()

Получить значение ключа маршрута.

string getRouteKeyName()

Получить ключ маршрута для модели.

Модель|null resolveRouteBinding(mixed $value, string|null $field = null)

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

Модель|null resolveSoftDeletableRouteBinding(mixed $value, string|null $field = null)

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

Модель|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

Получить дочернюю модель по связанному значению.

Модель|null resolveSoftDeletableChildRouteBinding(string $childType, mixed $value, string|null $field)

Получить дочернюю модель по связанному значению.

Отношение resolveChildRouteBindingQuery(string $childType, mixed $value, string|null $field)

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

string childRouteBindingRelationshipName(string $childType)

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

Relation resolveRouteBindingQuery(Model|Relation $query, mixed $value, string|null $field = null)

Получить модель для привязанного значения.

string getForeignKey()

Получить имя поля внешнего ключа по умолчанию для модели.

int getPerPage()

Получить количество моделей, возвращаемых на страницу.

$this setPerPage(int $perPage)

Установить количество моделей, возвращаемых на страницу.

static bool preventsLazyLoading()

Определить, отключена ли ленивая загрузка.

static bool preventsSilentlyDiscardingAttributes()

Определить, отключено ли безмолное удаление защищенных атрибутов.

static bool preventsAccessingMissingAttributes()

Определить, отключен ли доступ к отсутствующим атрибутам.

string broadcastChannelRoute()

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

string broadcastChannel()

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

mixed __get(string $key)

Динамически получить атрибуты модели.

void __set(string $key, mixed $value)

Динамически установить атрибуты модели.

bool offsetExists(mixed $offset)

Определить, существует ли заданный атрибут.

mixed offsetGet(mixed $offset)

Получить значение для заданного смещения.

void offsetSet(mixed $offset, mixed $value)

Установить значение для заданного смещения.

void offsetUnset(mixed $offset)

Удалить значение для заданного смещения.

bool __isset(string $key)

Определить, существует ли атрибут или отношение в модели.

void __unset(string $key)

Удалить атрибут из модели.

mixed __call(string $method, array $parameters)

Обработать динамические вызовы методов в модели.

static mixed __callStatic(string $method, array $parameters)

Обработать динамические статические вызовы методов в модели.

string __toString()

Преобразовать модель в строковое представление.

$this escapeWhenCastingToString(bool $escape = true)

Указать, что строковое представление объекта должно быть экранировано при вызове __toString.

array __sleep()

Подготовить объект к сериализации.

void __wakeup()

При десериализации модели проверить, нужно ли ее инициализировать.

Подробности

array attributesToArray()

Преобразовать атрибуты модели в массив.

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

array

protected array addDateAttributesToArray(array $attributes)

Добавить атрибуты даты в массив атрибутов.

Параметры

array $attributes

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

array

protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

Добавить измененные атрибуты в массив атрибутов.

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

Добавить отформатированные атрибуты в массив атрибутов.

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array getArrayableAttributes()

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

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

array

protected array getArrayableAppends()

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

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

array

array relationsToArray()

Получить отношения модели в формате массива.

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

array

protected array getArrayableRelations()

Получить массив всех преобразуемых в массив отношений.

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

array

protected array getArrayableItems(array $values)

Получить массив всех преобразуемых в массив значений.

Параметры

array $values

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

array

mixed getAttribute(string $key)

Получить атрибут из модели.

Параметры

string $key

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

mixed

protected null throwMissingAttributeExceptionIfApplicable(string $key)

Либо выбросить исключение отсутствия атрибута, либо вернуть null в зависимости от конфигурации Eloquent.

Параметры

string $key

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

null

Исключения

MissingAttributeException

mixed getAttributeValue(string $key)

Получить простое атрибут (не отношение).

Параметры

string $key

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

mixed

protected mixed getAttributeFromArray(string $key)

Получить атрибут из массива $attributes.

Параметры

string $key

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

mixed

mixed getRelationValue(string $key)

Получить отношение.

Параметры

string $key

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

mixed

bool isRelation(string $key)

Определить, является ли заданный ключ методом отношения в модели.

Параметры

string $key

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

bool

protected mixed handleLazyLoadingViolation(string $key)

Обработать нарушение леничной загрузки.

Параметры

string $key

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

mixed

protected mixed getRelationshipFromMethod(string $method)

Получить значение отношения из метода.

Параметры

string $method

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

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

Определить, существует ли мутатор get для атрибута.

Параметры

string $key

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

bool

bool hasAttributeMutator(string $key)

Определить, существует ли мутатор, помеченный как «Атрибут» с возвращаемым типом, для атрибута.

Параметры

string $key

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

bool

bool hasAttributeGetMutator(string $key)

Определить, существует ли мутатор get, помеченный как «Атрибут» с возвращаемым типом, для атрибута.

Параметры

string $key

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

bool

protected mixed mutateAttribute(string $key, mixed $value)

Получить значение атрибута с помощью его мутатора.

Параметры

string $key
mixed $value

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

mixed

protected mixed mutateAttributeMarkedAttribute(string $key, mixed $value)

Получить значение атрибута, помеченного как «Атрибут» с возвращаемым типом, с помощью его мутатора.

Параметры

string $key
mixed $value

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

mixed

protected mixed mutateAttributeForArray(string $key, mixed $value)

Получить значение атрибута с помощью его мутатора для преобразования в массив.

Параметры

string $key
mixed $value

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

mixed

$this mergeCasts(array $casts)

Объединить новые преобразования с существующими преобразованиями в модели.

Параметры

array $casts

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

$this

protected mixed castAttribute(string $key, mixed $value)

Преобразовать атрибут в базовый тип PHP.

Параметры

string $key
mixed $value

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

mixed

protected mixed getClassCastableAttributeValue(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

mixed

protected mixed getEnumCastableAttributeValue(string $key, mixed $value)

Преобразовать заданный атрибут в перечисление.

Параметры

string $key
mixed $value

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

mixed

protected string getCastType(string $key)

Получить тип преобразования для атрибута модели.

Параметры

string $key

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

string

protected mixed deviateClassCastableAttribute(string $method, string $key, mixed $value)

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

Параметры

string $method
string $key
mixed $value

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

mixed

protected mixed serializeClassCastableAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

mixed

protected bool isCustomDateTimeCast(string $cast)

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

Параметры

string $cast

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

bool

protected bool isImmutableCustomDateTimeCast(string $cast)

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

Parameters

string $cast

Return Value

bool

protected bool isDecimalCast(string $cast)

Определить, является ли тип преобразования десятичным преобразованием.

Parameters

string $cast

Return Value

bool

mixed setAttribute(string $key, mixed $value)

Установить заданный атрибут в модели.

Parameters

string $key
mixed $value

Return Value

mixed

bool hasSetMutator(string $key)

Определить, существует ли мутатор установки для атрибута.

Parameters

string $key

Return Value

bool

bool hasAttributeSetMutator(string $key)

Определить, существует ли мутатор установки для атрибута с типом возвращаемого значения "Атрибут".

Parameters

string $key

Return Value

bool

protected mixed setMutatedAttributeValue(string $key, mixed $value)

Установить значение атрибута с использованием его мутатора.

Parameters

string $key
mixed $value

Return Value

mixed

protected mixed setAttributeMarkedMutatedAttributeValue(string $key, mixed $value)

Установить значение атрибута с типом возвращаемого значения "Атрибут" с использованием его мутатора.

Parameters

string $key
mixed $value

Return Value

mixed

protected bool isDateAttribute(string $key)

Определить, является ли данный атрибут датой или преобразуемым в дату.

Parameters

string $key

Return Value

bool

$this fillJsonAttribute(string $key, mixed $value)

Установить заданный атрибут JSON в модели.

Parameters

string $key
mixed $value

Return Value

$this

protected void setClassCastableAttribute(string $key, mixed $value)

Установить значение атрибута, преобразуемого в класс.

Parameters

string $key
mixed $value

Return Value

void

protected void setEnumCastableAttribute(string $key, UnitEnum|string|int $value)

Установить значение атрибута, преобразуемого в перечисление.

Parameters

string $key
UnitEnum|string|int $value

Return Value

void

protected UnitEnum|BackedEnum getEnumCaseFromValue(string $enumClass, string|int $value)

Получить экземпляр элемента перечисления по заданному классу и значению.

Parameters

string $enumClass
string|int $value

Return Value

UnitEnum|BackedEnum

protected string|int getStorableEnumValue(UnitEnum|BackedEnum $value)

Получить сохраняемое значение из заданного перечисления.

Parameters

UnitEnum|BackedEnum $value

Return Value

string|int

protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)

Получить массив атрибутов с заданным ключом и установленным значением.

Parameters

string $path
string $key
mixed $value

Return Value

$this

protected array getArrayAttributeByKey(string $key)

Получить массив атрибутов по ключу или вернуть пустой массив, если он не задан.

Parameters

string $key

Return Value

array

protected string castAttributeAsJson(string $key, mixed $value)

Преобразовать заданный атрибут в JSON.

Parameters

string $key
mixed $value

Return Value

string

protected string asJson(mixed $value)

Кодировать заданное значение в JSON.

Parameters

mixed $value

Return Value

string

mixed fromJson(string $value, bool $asObject = false)

Декодировать заданный JSON в массив или объект.

Parameters

string $value
bool $asObject

Return Value

mixed

mixed fromEncryptedString(string $value)

Расшифровать заданную зашифрованную строку.

Parameters

string $value

Return Value

mixed

protected string castAttributeAsEncryptedString(string $key, mixed $value)

Преобразовать заданный атрибут в зашифрованную строку.

Parameters

string $key
mixed $value

Return Value

string

static void encryptUsing(Encrypter|null $encrypter)

Установите экземпляр шифрования, который будет использоваться для шифрования атрибутов.

Параметры

Encrypter|null $encrypter

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

void

protected string castAttributeAsHashedString(string $key, mixed $value)

Преобразуйте заданный атрибут в хешированную строку.

Параметры

string $key
mixed $value

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

string

mixed fromFloat(mixed $value)

Декодировать заданное число с плавающей запятой.

Параметры

mixed $value

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

mixed

protected string asDecimal(float|string $value, int $decimals)

Возвращает десятичное число в виде строки.

Параметры

float|string $value
int $decimals

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

string

protected Carbon asDate(mixed $value)

Возвращает метку времени как объект DateTime с временем, установленным в 00:00:00.

Параметры

mixed $value

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

Carbon

protected Carbon asDateTime(mixed $value)

Возвращает метку времени как объект DateTime.

Параметры

mixed $value

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

Carbon

protected bool isStandardDateFormat(string $value)

Определить, соответствует ли заданное значение стандартному формату даты.

Параметры

string $value

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

bool

string|null fromDateTime(mixed $value)

Преобразовать DateTime в хранимую строку.

Параметры

mixed $value

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

string|null

protected int asTimestamp(mixed $value)

Возвращает метку времени как Unix timestamp.

Параметры

mixed $value

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

int

protected string serializeDate(DateTimeInterface $date)

Подготовить дату к сериализации в массив/JSON.

Параметры

DateTimeInterface $date

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

string

array getDates()

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

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

array

string getDateFormat()

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

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

string

$this setDateFormat(string $format)

Установить формат даты, используемый моделью.

Параметры

string $format

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

$this

bool hasCast(string $key, array|string|null $types = null)

Определить, должен ли атрибут быть преобразован в родной тип.

Параметры

string $key
array|string|null $types

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

bool

array getCasts()

Получить массив преобразуемых атрибутов.

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

array

protected bool isDateCastable(string $key)

Определить, может ли значение быть преобразовано в дату/DateTime для обработки входных данных.

Параметры

string $key

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

bool

protected bool isDateCastableWithCustomFormat(string $key)

Определить, может ли значение быть преобразовано в пользовательский формат даты/DateTime для обработки входных данных.

Параметры

string $key

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

bool

protected bool isJsonCastable(string $key)

Определить, может ли значение быть преобразовано в JSON для обработки входных данных.

Параметры

string $key

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

bool

protected bool isEncryptedCastable(string $key)

Определить, может ли значение быть преобразовано в зашифрованный тип для обработки входных данных.

Параметры

string $key

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

bool

protected bool isClassCastable(string $key)

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

Параметры

string $key

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

bool

Исключения

InvalidCastException

protected bool isEnumCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isClassDeviable(string $key)

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

Параметры

string $key

Значение результата

bool

Исключения

InvalidCastException

protected bool isClassSerializable(string $key)

Определить, может ли ключ сериализоваться с использованием пользовательского класса.

Параметры

string $key

Значение результата

bool

Исключения

InvalidCastException

protected mixed resolveCasterClass(string $key)

Разрешить пользовательский класс-кастер для заданного ключа.

Параметры

string $key

Значение результата

mixed

protected string parseCasterClass(string $class)

Обработать заданный класс-кастер, удалив все аргументы.

Параметры

string $class

Значение результата

string

protected void mergeAttributesFromCachedCasts()

Объединить класс-кастер и атрибут-кастер обратно в модель.

Значение результата

void

protected void mergeAttributesFromClassCasts()

Объединить атрибуты класса-кастера обратно в модель.

Значение результата

void

protected void mergeAttributesFromAttributeCasts()

Объединить атрибуты класса-кастера обратно в модель.

Значение результата

void

protected array normalizeCastClassResponse(string $key, mixed $value)

Нормализовать ответ от пользовательского класса-кастера.

Параметры

string $key
mixed $value

Значение результата

array

array getAttributes()

Получить все текущие атрибуты модели.

Значение результата

array

protected array getAttributesForInsert()

Получить все текущие атрибуты модели для операции вставки.

Значение результата

array

$this setRawAttributes(array $attributes, bool $sync = false)

Установить массив атрибутов модели. Проверка не выполняется.

Параметры

array $attributes
bool $sync

Значение результата

$this

mixed|array getOriginal(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели.

Параметры

string|null $key
mixed $default

Значение результата

mixed|array

protected mixed|array getOriginalWithoutRewindingModel(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели.

Параметры

string|null $key
mixed $default

Значение результата

mixed|array

mixed|array getRawOriginal(string|null $key = null, mixed $default = null)

Получить исходные значения атрибутов модели в сыром виде.

Параметры

string|null $key
mixed $default

Значение результата

mixed|array

array only(array|mixed $attributes)

Получить подмножество атрибутов модели.

Параметры

array|mixed $attributes

Значение результата

array

$this syncOriginal()

Синхронизировать исходные атрибуты с текущими.

Значение результата

$this

$this syncOriginalAttribute(string $attribute)

Синхронизировать один исходный атрибут со своим текущим значением.

Параметры

string $attribute

Значение результата

$this

$this syncOriginalAttributes(array|string $attributes)

Синхронизировать несколько исходных атрибутов с их текущими значениями.

Параметры

array|string $attributes

Значение результата

$this

$this syncChanges()

Синхронизировать измененные атрибуты.

Значение результата

$this

bool isDirty(array|string|null $attributes = null)

Определить, была ли изменена модель или какой-либо из указанных атрибутов.

Параметры

array|string|null $attributes

Значение результата

bool

bool isClean(array|string|null $attributes = null)

Определить, остались ли неизменными модель или все указанные атрибуты.

Параметры

array|string|null $attributes

Значение результата

bool

$this discardChanges()

Отбросить изменения атрибутов и сбросить атрибуты до их исходного состояния.

Значение результата

$this

bool wasChanged(array|string|null $attributes = null)

Определить, был ли изменён образец или какой-либо из предоставленных атрибутов, когда образец был последний раз сохранён.

Parameters

array|string|null $attributes

Return Value

bool

protected bool hasChanges(array $changes, array|string|null $attributes = null)

Определить, были ли изменены какие-либо из предоставленных атрибутов, когда образец был последний раз сохранён.

Parameters

array $changes
array|string|null $attributes

Return Value

bool

array getDirty()

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

Return Value

array

protected array getDirtyForUpdate()

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

Return Value

array

array getChanges()

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

Return Value

array

bool originalIsEquivalent(string $key)

Определить, эквивалентны ли новые и старые значения для заданного ключа.

Parameters

string $key

Return Value

bool

protected mixed transformModelValue(string $key, mixed $value)

Преобразовать исходное значение образца с помощью мутаторов, преобразований и т. д.

Parameters

string $key
mixed $value

Return Value

mixed

$this append(array|string $attributes)

Добавить атрибуты к запросу при построении запроса.

Parameters

array|string $attributes

Return Value

$this

array getAppends()

Получить аксессоры, которые добавляются к массивам модели.

Return Value

array

$this setAppends(array $appends)

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

Parameters

array $appends

Return Value

$this

bool hasAppended(string $attribute)

Возвращает, был ли аксессор атрибута добавлен.

Parameters

string $attribute

Return Value

bool

array getMutatedAttributes()

Получить изменённые атрибуты для данного экземпляра.

Return Value

array

static void cacheMutatedAttributes(object|string $classOrInstance)

Извлечь и кэшировать все изменённые атрибуты класса.

Parameters

object|string $classOrInstance

Return Value

void

static protected array getMutatorMethods(mixed $class)

Получить все методы мутации атрибутов.

Parameters

mixed $class

Return Value

array

static protected array getAttributeMarkedMutatorMethods(mixed $class)

Получить все методы мутации атрибутов с возвращаемым типом «Атрибут».

Parameters

mixed $class

Return Value

array

static void bootHasEvents()

Инициализировать обработчик событий has для модели.

Return Value

void

static array resolveObserveAttributes()

Разрешить имена классов для наблюдения из атрибутов.

Return Value

array

static void observe(object|array|string $classes)

Зарегистрировать наблюдателей для модели.

Parameters

object|array|string $classes

Return Value

void

Exceptions

RuntimeException

protected void registerObserver(object|string $class)

Зарегистрировать единственного наблюдателя для модели.

Parameters

object|string $class

Return Value

void

Exceptions

RuntimeException

array getObservableEvents()

Получить имена событий, подлежащих наблюдению.

Return Value

array

$this setObservableEvents(array $observables)

Установить имена событий, подлежащих наблюдению.

Parameters

array $observables

Return Value

$this

void addObservableEvents(array|mixed $observables)

Добавить имя события, подлежащего наблюдению.

Parameters

array|mixed $observables

Return Value

void

void removeObservableEvents(array|mixed $observables)

Удалить имя события, подлежащего наблюдению.

Parameters

array|mixed $observables

Return Value

void

static protected void registerModelEvent(string $event, QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие модели в диспетчере.

Параметры

string $event
QueuedClosure|Closure|string|array $callback

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

void

protected mixed fireModelEvent(string $event, bool $halt = true)

Вызвать заданное событие для модели.

Параметры

string $event
bool $halt

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

mixed

protected mixed|null fireCustomModelEvent(string $event, string $method)

Вызвать пользовательское событие модели для заданного события.

Параметры

string $event
string $method

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

mixed|null

protected mixed filterModelEventResults(mixed $result)

Отфильтровать результаты событий модели.

Параметры

mixed $result

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

mixed

static void retrieved(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие получения модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void saving(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие сохранения модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void saved(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие сохранения модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void updating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие обновления модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void updated(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие обновления модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void creating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие создания модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void created(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие создания модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void replicating(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие копирования модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void deleting(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие удаления модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void deleted(QueuedClosure|Closure|string|array $callback)

Зарегистрировать событие удаления модели в диспетчере.

Параметры

QueuedClosure|Closure|string|array $callback

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

void

static void flushEventListeners()

Удалить все обработчики событий для модели.

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

void

статический Диспетчер событий getEventDispatcher()

Получить экземпляр диспетчера событий.

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

Диспетчер событий

статический void setEventDispatcher(Диспетчер событий $dispatcher)

Установить экземпляр диспетчера событий.

Параметры

Диспетчер событий $dispatcher

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

void

статический void unsetEventDispatcher()

Удалить диспетчер событий для моделей.

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

void

статический смешанный withoutEvents(callable $callback)

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

Параметры

callable $callback

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

смешанный

статический void bootHasGlobalScopes()

Запустить тред has global scopes для модели.

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

void

статический массив resolveGlobalScopeAttributes()

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

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

массив

статический смешанный addGlobalScope(Scope|Closure|строка $scope, Scope|Closure|null $implementation = null)

Зарегистрировать новое глобальное ограничение для модели.

Параметры

Scope|Closure|строка $scope
Scope|Closure|null $implementation

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

смешанный

Исключения

Исключение недействительного аргумента

статический void addGlobalScopes(массив $scopes)

Зарегистрировать несколько глобальных ограничений для модели.

Параметры

массив $scopes

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

void

статический bool hasGlobalScope(Scope|строка $scope)

Определить, имеет ли модель глобальное ограничение.

Параметры

Scope|строка $scope

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

bool

статический Scope|Closure|null getGlobalScope(Scope|строка $scope)

Получить глобальное ограничение, зарегистрированное в модели.

Параметры

Scope|строка $scope

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

Scope|Closure|null

статический массив getAllGlobalScopes()

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

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

массив

статический void setAllGlobalScopes(массив $scopes)

Установить текущие глобальные ограничения.

Параметры

массив $scopes

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

void

массив getGlobalScopes()

Получить глобальные ограничения для этого экземпляра класса.

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

массив

смешанный relationResolver(строка $class, строка $key)

Получить динамический обработчик отношений, если он определен или унаследован, или вернуть null.

Параметры

строка $class
строка $key

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

смешанный

статический void resolveRelationUsing(строка $name, Closure $callback)

Определить динамический обработчик отношений.

Параметры

строка $name
Closure $callback

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

void

HasOne hasOne(строка $related, строка|null $foreignKey = null, строка|null $localKey = null)

Определить отношение один-к-одному.

Параметры

строка $related
строка|null $foreignKey
строка|null $localKey

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

HasOne

защищенный HasOne newHasOne(Builder $query, Модель $parent, строка $foreignKey, строка $localKey)

Создать новое отношение один-к-одному.

Параметры

Builder $query
Модель $parent
строка $foreignKey
строка $localKey

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

HasOne
END_OF_DOCUMENT_MARKER

HasOneThrough hasOneThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определите отношение "один ко многим через" (has-one-through).

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

Значение результата

HasOneThrough

protected HasOneThrough newHasOneThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализируйте новое отношение "один ко многим через" (HasOneThrough).

Параметры

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

Значение результата

HasOneThrough

MorphOne morphOne(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определите полиморфное отношение "один к одному".

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

Значение результата

MorphOne

protected MorphOne newMorphOne(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализируйте новое полиморфное отношение "один к одному".

Параметры

Builder $query
Model $parent
string $type
string $id
string $localKey

Значение результата

MorphOne

BelongsTo belongsTo(string $related, string|null $foreignKey = null, string|null $ownerKey = null, string|null $relation = null)

Определите обратное отношение "один ко многим" или "многие ко многим".

Параметры

string $related
string|null $foreignKey
string|null $ownerKey
string|null $relation

Значение результата

BelongsTo

protected BelongsTo newBelongsTo(Builder $query, Model $child, string $foreignKey, string $ownerKey, string $relation)

Инициализируйте новое отношение "belongs to".

Параметры

Builder $query
Model $child
string $foreignKey
string $ownerKey
string $relation

Значение результата

BelongsTo

MorphTo morphTo(string|null $name = null, string|null $type = null, string|null $id = null, string|null $ownerKey = null)

Определите полиморфное, обратное отношение "один к одному" или "многие ко многим".

Параметры

string|null $name
string|null $type
string|null $id
string|null $ownerKey

Значение результата

MorphTo

protected MorphTo morphEagerTo(string $name, string $type, string $id, string $ownerKey)

Определите полиморфное, обратное отношение "один к одному" или "многие ко многим".

Параметры

string $name
string $type
string $id
string $ownerKey

Значение результата

MorphTo

protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id, string $ownerKey)

Определите полиморфное, обратное отношение "один к одному" или "многие ко многим".

Параметры

string $target
string $name
string $type
string $id
string $ownerKey

Значение результата

MorphTo

protected MorphTo newMorphTo(Builder $query, Model $parent, string $foreignKey, string $ownerKey, string $type, string $relation)

Инициализируйте новое полиморфное отношение "MorphTo".

Параметры

Builder $query
Model $parent
string $foreignKey
string $ownerKey
string $type
string $relation

Значение результата

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

Значение результата

string

protected string guessBelongsToRelation()

Угадать имя отношения «принадлежит».

Значение возвращаемого значения

string

PendingHasThroughRelationship through(string|HasMany|HasOne $relationship)

Создать ожидаемое отношение «многие-ко-многим» или «один-ко-многим» через.

Параметры

string|HasMany|HasOne $relationship

Значение возвращаемого значения

PendingHasThroughRelationship

HasMany hasMany(string $related, string|null $foreignKey = null, string|null $localKey = null)

Определить отношение «один-ко-многим».

Параметры

string $related
string|null $foreignKey
string|null $localKey

Значение возвращаемого значения

HasMany

protected HasMany newHasMany(Builder $query, Model $parent, string $foreignKey, string $localKey)

Инициализировать новое отношение «один-ко-многим».

Параметры

Builder $query
Model $parent
string $foreignKey
string $localKey

Значение возвращаемого значения

HasMany

HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null, string|null $secondLocalKey = null)

Определить отношение «многие-ко-многим через».

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey
string|null $secondLocalKey

Значение возвращаемого значения

HasManyThrough

protected HasManyThrough newHasManyThrough(Builder $query, Model $farParent, Model $throughParent, string $firstKey, string $secondKey, string $localKey, string $secondLocalKey)

Инициализировать новое отношение «многие-ко-многим через».

Параметры

Builder $query
Model $farParent
Model $throughParent
string $firstKey
string $secondKey
string $localKey
string $secondLocalKey

Значение возвращаемого значения

HasManyThrough

MorphMany morphMany(string $related, string $name, string|null $type = null, string|null $id = null, string|null $localKey = null)

Определить полиморфное отношение «один-ко-многим».

Параметры

string $related
string $name
string|null $type
string|null $id
string|null $localKey

Значение возвращаемого значения

MorphMany

protected MorphMany newMorphMany(Builder $query, Model $parent, string $type, string $id, string $localKey)

Инициализировать новое полиморфное отношение «один-ко-многим».

Параметры

Builder $query
Model $parent
string $type
string $id
string $localKey

Значение возвращаемого значения

MorphMany

BelongsToMany belongsToMany(string $related, string|Model>|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определить отношение «многие-ко-многим».

Параметры

string $related
string|Model>|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation

Значение возвращаемого значения

BelongsToMany

protected BelongsToMany newBelongsToMany(Builder $query, Model $parent, string|Model> $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Инициализировать новое отношение «многие-ко-многим».

Параметры

Builder $query
Model $parent
string|Model> $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName

Значение возвращаемого значения

BelongsToMany
END_OF_DOCUMENT_MARKER

MorphToMany morphToMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null, bool $inverse = false)

Определить полиморфное много-ко-многие отношение.

Параметры

string $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation
bool $inverse

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

MorphToMany

protected MorphToMany newMorphToMany(Builder $query, Model $parent, string $name, string $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null, bool $inverse = false)

Инициализировать новое полиморфное много-ко-многие отношение.

Параметры

Builder $query
Model $parent
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName
bool $inverse

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

MorphToMany

MorphToMany morphedByMany(string $related, string $name, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

Определить полиморфное обратное много-ко-многие отношение.

Параметры

string $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
string|null $relation

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

MorphToMany

protected string|null guessBelongsToManyRelation()

Получить имя отношения belongsToMany.

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

string|null

string joiningTable(string $related, Model|null $instance = null)

Получить имя таблицы соединения для много-ко-многие отношения.

Параметры

string $related
Модель|null $instance

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

string

string joiningTableSegment()

Получить часть имени промежуточной таблицы для отношения belongsToMany.

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

string

bool touches(string $relation)

Определить, касается ли модель заданного отношения.

Параметры

string $relation

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

bool

void touchOwners()

Обновить связанные отношения модели.

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

void

protected array getMorphs(string $name, string $type, string $id)

Получить столбцы полиморфного отношения.

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

Получить имя класса для полиморфных отношений.

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

string

protected mixed newRelatedInstance(string $class)

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

Параметры

string $class

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

mixed

protected mixed newRelatedThroughInstance(string $class)

Создать новый экземпляр модели для связанной модели через промежуточную.

Параметры

string $class

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

mixed

array getRelations()

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

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

array

mixed getRelation(string $relation)

Получить указанное отношение.

Параметры

string $relation

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

mixed

bool relationLoaded(string $key)

Определить, загружено ли заданное отношение.

Параметры

string $key

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

bool

$this setRelation(string $relation, mixed $value)

Установить заданное отношение для модели.

Параметры

string $relation
mixed $value

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

$this

$this unsetRelation(string $relation)

Удалить загруженное отношение.

Параметры

string $relation

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

$this

$this setRelations(array $relations)

Установить массив отношений для модели.

Параметры

массив $relations

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

$this

$this withoutRelations()

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

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

$this

$this unsetRelations()

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

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

$this

array getTouchedRelations()

Получить отношения, которые затронуты при сохранении.

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

массив

$this setTouchedRelations(array $touches)

Установить отношения, которые затронуты при сохранении.

Параметры

массив $touches

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

$this

bool touch(string|null $attribute = null)

Обновить временную метку последнего обновления модели.

Параметры

строка|null $attribute

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

bool

bool touchQuietly(string|null $attribute = null)

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

Параметры

строка|null $attribute

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

bool

$this updateTimestamps()

Обновить временные метки создания и обновления.

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

$this

$this setCreatedAt(mixed $value)

Установить значение атрибута "created at".

Параметры

mixed $value

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

$this

$this setUpdatedAt(mixed $value)

Установить значение атрибута "updated at".

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

Получить свежую временную метку для модели.

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

Carbon

string freshTimestampString()

Получить свежую временную метку для модели.

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

строка

bool usesTimestamps()

Определить, использует ли модель временные метки.

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

bool

string|null getCreatedAtColumn()

Получить имя столбца "created at".

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

строка|null

string|null getUpdatedAtColumn()

Получить имя столбца "updated at".

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

строка|null

string|null getQualifiedCreatedAtColumn()

Получить полностью квалифицированный столбец "created at".

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

строка|null

string|null getQualifiedUpdatedAtColumn()

Получить полностью квалифицированный столбец "updated at".

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

строка|null

static mixed withoutTimestamps(callable $callback)

Отключить временные метки для текущего класса в рамках заданного обратного вызова.

Параметры

обратный вызов $callback

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

mixed

static mixed withoutTimestampsOn(array $models, callable $callback)

Отключить временные метки для указанных классов моделей в рамках заданного обратного вызова.

Параметры

массив $models
обратный вызов $callback

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

mixed

static bool isIgnoringTimestamps(string|null $class = null)

Определить, игнорирует ли данная модель временные метки/события.

Параметры

строка|null $class

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

bool

bool usesUniqueIds()

Определить, использует ли модель уникальные идентификаторы.

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

bool

void setUniqueIds()

Сгенерировать уникальные ключи для модели.

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

void

string newUniqueId()

Сгенерировать новый ключ для модели.

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

строка

array uniqueIds()

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

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

массив

string[] getHidden()

Получить скрытые атрибуты для модели.

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

массив строк

$this setHidden(array $hidden)

Установить скрытые атрибуты для модели.

Параметры

массив $hidden

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

$this

string[] getVisible()

Получить видимые атрибуты для модели.

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

string[]

$this setVisible(array $visible)

Установить видимые атрибуты для модели.

Параметры

array $visible

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

$this

$this makeVisible(string[]|string|null $attributes)

Сделать заданные, обычно скрытые, атрибуты видимыми.

Параметры

string[]|string|null $attributes

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

$this

$this makeVisibleIf(bool|Closure $condition, string[]|string|null $attributes)

Сделать заданные, обычно скрытые, атрибуты видимыми, если заданное условие истинно.

Параметры

bool|Closure $condition
string[]|string|null $attributes

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

$this

$this makeHidden(string[]|string|null $attributes)

Сделать заданные, обычно видимые, атрибуты скрытыми.

Параметры

string[]|string|null $attributes

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

$this

$this makeHiddenIf(bool|Closure $condition, string[]|string|null $attributes)

Сделать заданные, обычно видимые, атрибуты скрытыми, если заданное условие истинно.

Параметры

bool|Closure $condition
string[]|string|null $attributes

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

$this

string[] getFillable()

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

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

string[]

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

$this mergeFillable(array $fillable)

Объединить новые атрибуты, которые можно заполнять, с существующими атрибутами, которые можно заполнять, для модели.

Параметры

array $fillable

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

$this

string[] getGuarded()

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

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

string[]

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

$this mergeGuarded(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

Отключить все ограничения на массовое присвоение значений.

Параметры

bool $state

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

void

static void reguard()

Включить ограничения на массовое присвоение значений.

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

void

static bool isUnguarded()

Определить, находится ли текущее состояние в режиме "unguarded".

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

bool

static mixed unguarded(callable $callback)

Выполнить заданный вызов, будучи в режиме "unguarded".

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

Определить, можно ли массово присвоить значение заданному атрибуту.

Параметры

string $key

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

bool

bool isGuarded(string $key)

Определить, является ли заданный ключ защищенным.

Параметры

string $key

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

bool

protected bool isGuardableColumn(string $key)

Определить, является ли заданный столбец допустимым защищенным столбцом.

Параметры

string $key

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

bool

bool totallyGuarded()

Определить, полностью ли защищена модель.

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Переадресовать вызов метода заданному объекту.

Параметры

mixed $object
string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

void __construct(array $attributes = [])

Создать новый экземпляр модели Eloquent.

Parameters

array $attributes

Return Value

void

protected void bootIfNotBooted()

Проверить, нужно ли загружать модель, и если нужно, сделать это.

Return Value

void

static protected void booting()

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

Return Value

void

static protected void boot()

Загрузить модель и ее трейты.

Return Value

void

static protected void bootTraits()

Загрузить все загружаемые трейты модели.

Return Value

void

protected void initializeTraits()

Инициализировать все инициализируемые трейты модели.

Return Value

void

static protected void booted()

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

Return Value

void

static void clearBootedModels()

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

Return Value

void

static void withoutTouching(callable $callback)

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

Parameters

callable $callback

Return Value

void

static void withoutTouchingOn(array $models, callable $callback)

Отключает касание модели отношений для заданных классов моделей во время выполнения данного обратного вызова.

Parameters

array $models
callable $callback

Return Value

void

static bool isIgnoringTouch(string|null $class = null)

Определить, игнорирует ли данная модель касания.

Parameters

string|null $class

Return Value

bool

static void shouldBeStrict(bool $shouldBeStrict = true)

Указать, что модели должны предотвращать ленивую загрузку, молча игнорировать атрибуты и получать доступ к отсутствующим атрибутам.

Parameters

bool $shouldBeStrict

Return Value

void

static void preventLazyLoading(bool $value = true)

Предотвратить ленивую загрузку отношений модели.

Parameters

bool $value

Return Value

void

static void handleLazyLoadingViolationUsing(callable|null $callback)

Зарегистрировать обратный вызов, ответственный за обработку нарушений ленивой загрузки.

Parameters

callable|null $callback

Return Value

void

static void preventSilentlyDiscardingAttributes(bool $value = true)

Предотвратить молчаливое удаление атрибутов, не являющихся заполняемыми.

Parameters

bool $value

Return Value

void

static void handleDiscardedAttributeViolationUsing(callable|null $callback)

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

Parameters

callable|null $callback

Return Value

void

static void preventAccessingMissingAttributes(bool $value = true)

Запретить доступ к отсутствующим атрибутам в извлеченных моделях.

Parameters

bool $value

Return Value

void

static void handleMissingAttributeViolationUsing(callable|null $callback)

Зарегистрировать обратный вызов, ответственный за обработку нарушений отсутствующих атрибутов.

Parameters

callable|null $callback

Return Value

void

static mixed withoutBroadcasting(callable $callback)

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

Parameters

callable $callback

Return Value

mixed
END_OF_DOCUMENT_MARKER

$this fill(array $attributes)

Заполнить модель массивом атрибутов.

Параметры

массив $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

Заполнить модель массивом атрибутов. Принудительно разрешить массовое назначение.

Параметры

массив $attributes

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

$this

string qualifyColumn(string $column)

Указать имя указанного столбца таблицей модели.

Параметры

строка $column

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

строка

array qualifyColumns(array $columns)

Указать указанные столбцы таблицей модели.

Параметры

массив $columns

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

массив

Модель newInstance(array $attributes = [], bool $exists = false)

Создать новый экземпляр данной модели.

Параметры

массив $attributes
булево $exists

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

Модель

Модель newFromBuilder(array $attributes = [], string|null $connection = null)

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

Параметры

массив $attributes
строка|null $connection

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

Модель

static Библиотека on(string|null $connection = null)

Начать запросы к модели на данном соединении.

Параметры

строка|null $connection

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

Библиотека

static Библиотека onWriteConnection()

Начать запросы к модели на соединении записи.

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

Библиотека

static Коллекция<int,static> all(array|string $columns = ['*'])

Получить все модели из базы данных.

Параметры

массив|строка $columns

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

Коллекция<int,static>

static Библиотека with(array|string $relations)

Начать запросы к модели с ленивой загрузкой.

Параметры

массив|строка $relations

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

Библиотека

$this load(array|string $relations)

Загрузить отношения модели.

Параметры

массив|строка $relations

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

$this

$this loadMorph(string $relation, array $relations)

Загрузить отношения для полиморфного отношения модели.

Параметры

строка $relation
массив $relations

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

$this

$this loadMissing(array|string $relations)

Загрузить отношения модели, если они еще не загружены.

Параметры

массив|строка $relations

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

$this

$this loadAggregate(array|string $relations, string $column, string|null $function = null)

Загрузить агрегации столбцов отношения модели.

Параметры

массив|строка $relations
строка $column
строка|null $function

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

$this

$this loadCount(array|string $relations)

Загрузить количество отношений модели.

Параметры

массив|строка $relations

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

$this

$this loadMax(array|string $relations, string $column)

Загрузить максимальные значения столбца отношения модели.

Параметры

массив|строка $relations
строка $column

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

$this

$this loadMin(array|string $relations, string $column)

Загрузить минимальные значения столбца отношения модели.

Параметры

массив|строка $relations
строка $column

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

$this

$this loadSum(array|string $relations, string $column)

Загрузить суммы значений столбца отношения модели.

Параметры

массив|строка $relations
строка $column

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

$this

$this loadAvg(array|string $relations, string $column)

Загрузить средние значения столбца отношения модели.

Параметры

массив|строка $relations
строка $column

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

$this

$this loadExists(array|string $relations)

Загрузить значения существования связанной модели.

Параметры

массив|строка $relations

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

$this
END_OF_DOCUMENT_MARKER

$this loadMorphAggregate(string $relation, array $relations, string $column, string|null $function = null)

Жадно загрузить агрегирование столбца отношения к полиморфному отношению модели.

Параметры

string $relation
array $relations
string $column
string|null $function

Значение возврата

$this

$this loadMorphCount(string $relation, array $relations)

Жадно загрузить подсчеты отношений по полиморфному отношению модели.

Параметры

string $relation
array $relations

Значение возврата

$this

$this loadMorphMax(string $relation, array $relations, string $column)

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

Параметры

string $relation
array $relations
string $column

Значение возврата

$this

$this loadMorphMin(string $relation, array $relations, string $column)

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

Параметры

string $relation
array $relations
string $column

Значение возврата

$this

$this loadMorphSum(string $relation, array $relations, string $column)

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

Параметры

string $relation
array $relations
string $column

Значение возврата

$this

$this loadMorphAvg(string $relation, array $relations, string $column)

Жадно загрузить средние значения столбца отношения к полиморфному отношению модели.

Параметры

string $relation
array $relations
string $column

Значение возврата

$this

protected int increment(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество.

Параметры

string $column
float|int $amount
array $extra

Значение возврата

int

protected int decrement(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество.

Параметры

string $column
float|int $amount
array $extra

Значение возврата

int

protected int incrementOrDecrement(string $column, float|int $amount, array $extra, string $method)

Выполнить метод увеличения или уменьшения на модели.

Параметры

string $column
float|int $amount
array $extra
string $method

Значение возврата

int

bool update(array $attributes = [], array $options = [])

Обновить модель в базе данных.

Параметры

array $attributes
array $options

Значение возврата

bool

bool updateOrFail(array $attributes = [], array $options = [])

Обновить модель в базе данных в рамках транзакции.

Параметры

array $attributes
array $options

Значение возврата

bool

Исключения

Throwable

bool updateQuietly(array $attributes = [], array $options = [])

Обновить модель в базе данных без повышения событий.

Параметры

array $attributes
array $options

Значение возврата

bool

protected int incrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Увеличить значение столбца на заданное количество без повышения событий.

Параметры

string $column
float|int $amount
array $extra

Значение возврата

int

protected int decrementQuietly(string $column, float|int $amount = 1, array $extra = [])

Уменьшить значение столбца на заданное количество без повышения событий.

Параметры

string $column
float|int $amount
array $extra

Значение возврата

int

bool push()

Сохранить модель и все ее отношения.

Значение возврата

bool

bool pushQuietly()

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

Значение возврата

bool

bool saveQuietly(array $options = [])

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

Параметры

array $options

Значение возврата

bool

bool save(array $options = [])

Сохранить модель в базе данных.

Параметры

array $options

Значение возврата

bool

bool saveOrFail(array $options = [])

Сохранить модель в базе данных в рамках транзакции.

Параметры

array $options

Значение возврата

bool

Исключения

Throwable

protected void finishSave(array $options)

Выполнить необходимые действия после сохранения модели.

Параметры

array $options

Значение возврата

void

protected bool performUpdate(Builder $query)

Выполнить операцию обновления модели.

Параметры

Builder $query

Значение возврата

bool

protected Builder setKeysForSelectQuery(Builder $query)

Установить ключи для запроса выборки.

Параметры

Builder $query

Значение возврата

Builder

protected mixed getKeyForSelectQuery()

Получить значение первичного ключа для запроса выборки.

Значение возврата

mixed

protected Builder setKeysForSaveQuery(Builder $query)

Установить ключи для запроса сохранения обновления.

Параметры

Builder $query

Значение возврата

Builder

protected mixed getKeyForSaveQuery()

Получить значение первичного ключа для запроса сохранения.

Значение возврата

mixed

protected bool performInsert(Builder $query)

Выполнить операцию вставки модели.

Параметры

Builder $query

Значение возврата

bool

protected void insertAndSetId(Builder $query, array $attributes)

Вставить заданные атрибуты и установить ID модели.

Параметры

Builder $query
array $attributes

Значение возврата

void

static int destroy(Collection|array|int|string $ids)

Удалить модели для заданных идентификаторов.

Параметры

Collection|array|int|string $ids

Значение возврата

int

bool|null delete()

Удалить модель из базы данных.

Значение возврата

bool|null

Исключения

LogicException

bool deleteQuietly()

Удалить модель из базы данных без поднятия событий.

Значение возврата

bool

bool|null deleteOrFail()

Удалить модель из базы данных в рамках транзакции.

Значение возврата

bool|null

Исключения

Throwable

bool|null forceDelete()

Принудительно удалить мягко удаленную модель.

Этот метод защищает разработчиков от запуска forceDelete, когда этот метод отсутствует.

Значение возврата

bool|null

protected void performDeleteOnModel()

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

Значение возврата

void

static Builder query()

Начать запрос модели.

Значение возврата

Builder

Builder newQuery()

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

Значение возврата

Builder

Builder|Model newModelQuery()

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

Значение возврата

Builder|Model

Builder newQueryWithoutRelationships()

Получить новый билдер запросов без загруженных отношений.

Значение возврата

Builder

Builder registerGlobalScopes(Builder $builder)

Зарегистрировать глобальные скопы для этого экземпляра билдера.

Параметры

Builder $builder

Значение возврата

Builder

Builder|Модель newQueryWithoutScopes()

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

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

Builder|Модель

Builder newQueryWithoutScope(Ограничение|string $scope)

Получить новую инстанцию запроса без заданного ограничения.

Параметры

Ограничение|string $scope

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

Builder

Builder newQueryForRestoration(array|int $ids)

Получить новый запрос для восстановления одной или нескольких моделей по их идентификаторам очереди.

Параметры

array|int $ids

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

Builder

Builder|Модель newEloquentBuilder(Builder $query)

Создать новый билдер запросов Eloquent для модели.

Параметры

Builder $query

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

Builder|Модель

protected Builder newBaseQueryBuilder()

Получить новую инстанцию билдера запросов для подключения.

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

Builder

Коллекция newCollection(array $models = [])

Создать новую инстанцию коллекции Eloquent.

Параметры

array $models

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

Коллекция

Связь newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)

Создать новую инстанцию модели связи.

Параметры

Модель $parent
array $attributes
string $table
bool $exists
string|null $using

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

Связь

bool hasNamedScope(string $scope)

Определить, содержит ли модель заданное ограничение.

Параметры

string $scope

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

bool

mixed callNamedScope(string $scope, array $parameters = [])

Применить заданное именованное ограничение, если возможно.

Параметры

string $scope
array $parameters

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

mixed

toArray()

Преобразовать инстанцию модели в массив.

string toJson(int $options = 0)

Преобразовать инстанцию модели в JSON.

Параметры

int $options

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

string

Исключения

JsonEncodingException

mixed jsonSerialize()

Преобразовать объект в сериализуемый в JSON.

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

mixed

Модель|null fresh(array|string $with = [])

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

Параметры

array|string $with

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

Модель|null

$this refresh()

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

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

$this

Модель replicate(array $except = null)

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

Параметры

array $except

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

Модель

Модель replicateQuietly(array $except = null)

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

Параметры

array $except

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

Модель

bool is(Модель|null $model)

Определить, имеют ли две модели одинаковый ID и принадлежат ли одной таблице.

Параметры

Модель|null $model

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

bool

bool isNot(Модель|null $model)

Определить, не являются ли две модели одинаковыми.

Параметры

Модель|null $model

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

bool

Подключение getConnection()

Получить подключение к базе данных для модели.

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

Подключение
END_OF_DOCUMENT_MARKER

строка|null getConnectionName()

Получить текущее имя подключения для модели.

Значение возврата

строка|null

$this setConnection(строка|null $name)

Установить подключение, связанное с моделью.

Параметры

строка|null $name

Значение возврата

$this

static Подключение resolveConnection(строка|null $connection = null)

Разрешить экземпляр подключения.

Параметры

строка|null $connection

Значение возврата

Подключение

static Интерфейс разрешения подключений|null getConnectionResolver()

Получить экземпляр разрешения подключений.

Значение возврата

Интерфейс разрешения подключений|null

static void setConnectionResolver(Интерфейс разрешения подключений $resolver)

Установить экземпляр разрешения подключений.

Параметры

Интерфейс разрешения подключений $resolver

Значение возврата

void

static void unsetConnectionResolver()

Удалить разрешение подключения для моделей.

Значение возврата

void

строка getTable()

Получить таблицу, связанную с моделью.

Значение возврата

строка

$this setTable(строка $table)

Установить таблицу, связанную с моделью.

Параметры

строка $table

Значение возврата

$this

строка getKeyName()

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

Значение возврата

строка

$this setKeyName(строка $key)

Установить первичный ключ для модели.

Параметры

строка $key

Значение возврата

$this

строка getQualifiedKeyName()

Получить имя квалифицированного ключа таблицы.

Значение возврата

строка

строка getKeyType()

Получить тип автоматически инкрементируемого ключа.

Значение возврата

строка

$this setKeyType(строка $type)

Установить тип данных для первичного ключа.

Параметры

строка $type

Значение возврата

$this

логическое значение getIncrementing()

Получить значение, указывающее, являются ли идентификаторы инкрементируемыми.

Значение возврата

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

$this setIncrementing(логическое значение $value)

Установить, являются ли идентификаторы инкрементируемыми.

Параметры

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

Значение возврата

$this

смешанное значение getKey()

Получить значение первичного ключа модели.

Значение возврата

смешанное значение

смешанное значение getQueueableId()

Получить идентификатор очереди для сущности.

Значение возврата

смешанное значение

массив getQueueableRelations()

Получить отношения очереди для сущности.

Значение возврата

массив

строка|null getQueueableConnection()

Получить подключение очереди для сущности.

Значение возврата

строка|null

смешанное значение getRouteKey()

Получить значение ключа маршрута модели.

Значение возврата

смешанное значение

строка getRouteKeyName()

Получить ключ маршрута для модели.

Значение возврата

строка

Модель|null resolveRouteBinding(смешанное значение $value, строка|null $field = null)

Получить модель для привязанного значения.

Параметры

смешанное значение $value
строка|null $field

Значение возврата

Модель|null

Модель|null resolveSoftDeletableRouteBinding(смешанное значение $value, строка|null $field = null)

Получить модель для привязанного значения.

Параметры

смешанное значение $value
строка|null $field

Значение возврата

Модель|null

Модель|null resolveChildRouteBinding(строка $childType, смешанное значение $value, строка|null $field)

Получить дочернюю модель для привязанного значения.

Параметры

строка $childType
смешанное значение $value
строка|null $field

Значение возврата

Модель|null

Модель|null resolveSoftDeletableChildRouteBinding(string $childType, mixed $value, string|null $field)

Получить дочернюю модель для связанного значения.

Параметры

string $childType
mixed $value
string|null $field

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

Модель|null

protected Связь resolveChildRouteBindingQuery(string $childType, mixed $value, string|null $field)

Получить запрос дочерней модели для связанного значения.

Параметры

string $childType
mixed $value
string|null $field

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

Связь

protected string childRouteBindingRelationshipName(string $childType)

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

Параметры

string $childType

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

string

Связь resolveRouteBindingQuery(Модель|Связь $query, mixed $value, string|null $field = null)

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

Параметры

Модель|Связь $query
mixed $value
string|null $field

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

Связь

string getForeignKey()

Получить имя внешнего ключа по умолчанию для модели.

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

string

int getPerPage()

Получить количество моделей на страницу.

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

int

$this setPerPage(int $perPage)

Установить количество моделей на страницу.

Параметры

int $perPage

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

$this

static bool preventsLazyLoading()

Определить, отключено ли ленивое загрузка.

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

bool

static bool preventsSilentlyDiscardingAttributes()

Определить, отключено ли безмолное удаление защищенных атрибутов.

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

bool

static bool preventsAccessingMissingAttributes()

Определить, отключен ли доступ к отсутствующим атрибутам.

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

bool

string broadcastChannelRoute()

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

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

string

string broadcastChannel()

Получить имя канала broadcast, связанное с данным объектом.

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

string

mixed __get(string $key)

Динамически получить атрибуты модели.

Параметры

string $key

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

mixed

void __set(string $key, mixed $value)

Динамически установить атрибуты модели.

Параметры

string $key
mixed $value

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

void

bool offsetExists(mixed $offset)

Определить, существует ли данный атрибут.

Параметры

mixed $offset

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

bool

mixed offsetGet(mixed $offset)

Получить значение для данного смещения.

Параметры

mixed $offset

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

mixed

void offsetSet(mixed $offset, mixed $value)

Установить значение для данного смещения.

Параметры

mixed $offset
mixed $value

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

void

void offsetUnset(mixed $offset)

Удалить значение для данного смещения.

Параметры

mixed $offset

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

void

bool __isset(string $key)

Определить, существует ли атрибут или отношение в модели.

Параметры

string $key

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

bool

void __unset(string $key)

Удалить атрибут из модели.

Параметры

string $key

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

void

mixed __call(string $method, array $parameters)

Обработка динамических вызовов методов в модели.

Параметры

string $method
array $parameters

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

mixed

static смешанный тип __callStatic(строка $method, массив $parameters)

Обработка динамических статических вызовов в модель.

Параметры

строка $method
массив $parameters

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

смешанный тип

строка __toString()

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

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

строка

$this escapeWhenCastingToString(булево $escape = true)

Указать, что строковое представление объекта должно быть экранировано при вызове __toString.

Параметры

булево $escape

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

$this

массив __sleep()

Подготовка объекта к сериализации.

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

массив

пустое значение __wakeup()

При десериализации модели проверить, нужно ли её загрузить.

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

пустое значение

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Eloquent/Model.html

Spec-Zone.ru

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