Spec-Zone.ru › Laravel 9

Модель

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

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes
ForwardsCalls

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

protected массив $attributes

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

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

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

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

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

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

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

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

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

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

Атрибуты, преобразованные с использованием мутаторов с типом возврата «Attribute».

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

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

из HasAttributes
protected массив deprecated $dates

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

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

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

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

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

из HasAttributes
static bool $snakeAttributes

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
static Encrypter|null $encrypter

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

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

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

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

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

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

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

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

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

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

Методы для отношений many-to-many.

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

Обработчики разрешения отношений.

из HasRelationships
bool $timestamps

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

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

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

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

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

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

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

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

Атрибуты, которые могут быть массово присвоены.

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

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

из GuardsAttributes
static protected bool $unguarded

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

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

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

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

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

protected строка $table

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

protected строка $primaryKey

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

protected строка $keyType

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

bool $incrementing

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

protected array $with

Связи для леничной загрузки при каждом запросе.

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

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

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)

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

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

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

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

Установить значение атрибута с возвращаемым типом «Атрибут» с помощью мутатора.

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
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.

из HasAttributes
bool isStandardDateFormat(string $value)

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

из HasAttributes
string|null fromDateTime(mixed $value)

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

из HasAttributes
int asTimestamp(mixed $value)

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

из HasAttributes
string serializeDate(DateTimeInterface $date)

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

из HasAttributes
array getDates()

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

из HasAttributes
string getDateFormat()

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

из HasAttributes
$this setDateFormat(string $format)

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

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

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

из HasAttributes
array getCasts()

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

из HasAttributes
bool isDateCastable(string $key)

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

из HasAttributes
bool isDateCastableWithCustomFormat(string $key)

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

из HasAttributes
bool isJsonCastable(string $key)

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

из HasAttributes
bool isEncryptedCastable(string $key)

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

из HasAttributes
bool isClassCastable(string $key)

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

из HasAttributes
bool isEnumCastable(string $key)

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

из HasAttributes
bool isClassDeviable(string $key)

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

из HasAttributes
bool isClassSerializable(string $key)

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

из HasAttributes
mixed resolveCasterClass(string $key)

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

из HasAttributes
string parseCasterClass(string $class)

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

из HasAttributes
void mergeAttributesFromCachedCasts()

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

из HasAttributes
void mergeAttributesFromClassCasts()

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

из HasAttributes
void mergeAttributesFromAttributeCasts()

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

из HasAttributes
array normalizeCastClassResponse(string $key, mixed $value)

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

из HasAttributes
array getAttributes()

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

из HasAttributes
array getAttributesForInsert()

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

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

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

из 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 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 observe(object|array|string $classes)

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

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

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

из HasEvents
array getObservableEvents()

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

из HasEvents
$this setObservableEvents(array $observables)

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

из HasEvents
void addObservableEvents(array|mixed $observables)

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

из HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

из HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasEvents
static void flushEventListeners()

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

из HasEvents
static Dispatcher getEventDispatcher()

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

из HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

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

из HasEvents
static void unsetEventDispatcher()

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

из HasEvents
static mixed withoutEvents(callable $callback)

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

из HasEvents
static mixed addGlobalScope(Scope|Closure|string $scope, Scope|Closure|null $implementation = null)

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

из HasGlobalScopes
static bool hasGlobalScope(Scope|string $scope)

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

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

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

из HasGlobalScopes
array getGlobalScopes()

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

из HasGlobalScopes
mixed relationResolver(string $class, string $key)

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

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

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

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

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

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

Создать новое отношение один-к-одному.

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

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

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

Создать новое отношение один-через-один.

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

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

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

Создать новое полиморфное отношение один-к-одному.

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

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

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

Создать новое отношение принадлежности.

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

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

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

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

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

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

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

Создать новое полиморфное обратное отношение.

из HasRelationships
static string getActualClassNameForMorph(string $class)

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

из HasRelationships
string guessBelongsToRelation()

Предсказать имя отношения "принадлежности".

из HasRelationships
PendingHasThroughRelationship through(string|HasMany|HasOne $relationship)

Создать ожидаемое отношение через-многие или через-один.

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

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

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

Создать новое отношение один-ко-многим.

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

Определите отношение "многие ко многим через".

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

Инициализируйте новое отношение "многие ко многим через".

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

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

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

Инициализируйте новое полиморфное отношение "один ко многим".

из HasRelationships
BelongsToMany belongsToMany(string $related, string|null $table = null, string|null $foreignPivotKey = null, string|null $relatedPivotKey = null, string|null $parentKey = null, string|null $relatedKey = null, string|null $relation = null)

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

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

Инициализируйте новое отношение "многие ко многим".

из 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, bool $inverse = false)

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

из 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)

Инициализируйте новое полиморфное отношение "многие ко многим".

из 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)

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

из HasRelationships
string|null guessBelongsToManyRelation()

Получить имя отношения "многие ко многим".

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

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

из HasRelationships
string joiningTableSegment()

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

из HasRelationships
bool touches(string $relation)

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

из HasRelationships
void touchOwners()

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

из HasRelationships
array getMorphs(string $name, string $type, string $id)

Получить столбцы полиморфного отношения.

из HasRelationships
string getMorphClass()

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

из HasRelationships
mixed newRelatedInstance(string $class)

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

из HasRelationships
mixed newRelatedThroughInstance(string $class)

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

из HasRelationships
array getRelations()

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

из HasRelationships
mixed getRelation(string $relation)

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

из HasRelationships
bool relationLoaded(string $key)

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

из HasRelationships
$this setRelation(string $relation, mixed $value)

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

из 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)

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

from HasTimestamps
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()

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

из GuardsAttributes
$this fillable(array $fillable)

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

из GuardsAttributes
$this mergeFillable(array $fillable)

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

из GuardsAttributes
string[] getGuarded()

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

из GuardsAttributes
$this guard(array $guarded)

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

из GuardsAttributes
$this mergeGuarded(array $guarded)

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

из GuardsAttributes
static void unguard(bool $state = true)

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

из GuardsAttributes
static void reguard()

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

из GuardsAttributes
static bool isUnguarded()

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

из GuardsAttributes
static mixed unguarded(callable $callback)

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

из GuardsAttributes
bool isFillable(string $key)

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

из GuardsAttributes
bool isGuarded(string $key)

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

из GuardsAttributes
bool isGuardableColumn(string $key)

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

из GuardsAttributes
bool totallyGuarded()

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

из GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

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

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

из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

из 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 $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 $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)

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

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

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

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|Model newEloquentBuilder(Builder $query)

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

Builder newBaseQueryBuilder()

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

Collection newCollection(array $models = [])

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

Pivot newPivot(Model $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 формат.

Model|null fresh(array|string $with = [])

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

$this refresh()

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

Model replicate(array $except = null)

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

Model replicateQuietly(array $except = null)

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

bool is(Model|null $model)

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

bool isNot(Model|null $model)

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

Connection getConnection()

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

string|null getConnectionName()

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

$this setConnection(string|null $name)

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

static Connection resolveConnection(string|null $connection = null)

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

static ConnectionResolverInterface getConnectionResolver()

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

static void setConnectionResolver(ConnectionResolverInterface $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()

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

Model|null resolveRouteBinding(mixed $value, string|null $field = null)

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

Model|null resolveSoftDeletableRouteBinding(mixed $value, string|null $field = null)

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

Model|null resolveChildRouteBinding(string $childType, mixed $value, string|null $field)

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

Model|null resolveSoftDeletableChildRouteBinding(string $childType, mixed $value, string|null $field)

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

Relation 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()

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

string broadcastChannel()

Получить имя канала broadcast, связанного с данной сущностью.

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)

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

Параметры

string $key

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

bool

bool hasAttributeMutator(string $key)

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

Параметры

string $key

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

bool

bool hasAttributeGetMutator(string $key)

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

Параметры

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)

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

Параметры

string $cast

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

bool

protected bool isDecimalCast(string $cast)

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

Параметры

string $cast

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

bool

mixed setAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

mixed

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

bool hasAttributeSetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

protected bool isDateAttribute(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

$this

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

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

Параметры

string $key
mixed $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)

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

Parameters

Encrypter|null $encrypter

Return Value

void

mixed fromFloat(mixed $value)

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

Parameters

mixed $value

Return Value

mixed

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

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

Parameters

float|string $value
int $decimals

Return Value

string

protected Carbon asDate(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected Carbon asDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected bool isStandardDateFormat(string $value)

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

Parameters

string $value

Return Value

bool

string|null fromDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

string|null

protected int asTimestamp(mixed $value)

Вернуть метку времени в виде метки Unix.

Parameters

mixed $value

Return Value

int

protected string serializeDate(DateTimeInterface $date)

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

Parameters

DateTimeInterface $date

Return Value

string

array getDates()

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

Return Value

array

строка getDateFormat()

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

Значение возврата

строка

$this setDateFormat(строка $format)

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

Параметры

строка $format

Значение возврата

$this

логическое значение hasCast(строка $key, массив|строка|null $types = null)

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

Параметры

строка $key
массив|строка|null $types

Значение возврата

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

массив getCasts()

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

Значение возврата

массив

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

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

Параметры

строка $key

Значение возврата

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

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

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

Параметры

строка $key

Значение возврата

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

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

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

Параметры

строка $key

Значение возврата

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

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

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

Параметры

строка $key

Значение возврата

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

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

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

Параметры

строка $key

Значение возврата

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

Исключения

InvalidCastException

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

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

Параметры

строка $key

Значение возврата

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

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

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

Параметры

строка $key

Значение возврата

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

Исключения

InvalidCastException

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

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

Параметры

строка $key

Значение возврата

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

Исключения

InvalidCastException

protected смешанный тип resolveCasterClass(строка $key)

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

Параметры

строка $key

Значение возврата

смешанный тип

protected строка parseCasterClass(строка $class)

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

Параметры

строка $class

Значение возврата

строка

protected ничего mergeAttributesFromCachedCasts()

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

Значение возврата

ничего

protected ничего mergeAttributesFromClassCasts()

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

Значение возврата

ничего

protected ничего mergeAttributesFromAttributeCasts()

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

Значение возврата

ничего

protected массив normalizeCastClassResponse(строка $key, смешанный тип $value)

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

Параметры

строка $key
смешанный тип $value

Значение возврата

массив

массив getAttributes()

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

Значение возврата

массив

protected массив getAttributesForInsert()

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

Значение возврата

массив

$this setRawAttributes(массив $attributes, логическое значение $sync = false)

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

Параметры

массив $attributes
логическое значение $sync

Значение возврата

$this

смешанный тип|массив getOriginal(строка|null $key = null, смешанный тип $default = null)

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

Параметры

строка|null $key
смешанный тип $default

Значение возврата

смешанный тип|массив

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)

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

Параметры

array|string|null $attributes

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

bool

protected bool hasChanges(array $changes, array|string|null $attributes = null)

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

Параметры

array $changes
array|string|null $attributes

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

bool

array getDirty()

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

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

array

array getChanges()

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

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

array

bool originalIsEquivalent(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getAppends()

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

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

array

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

bool hasAppended(string $attribute)

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

Параметры

string $attribute

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

bool

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(object|string $classOrInstance)

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

Параметры

object|string $classOrInstance

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

static protected array getAttributeMarkedMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

static void observe(object|array|string $classes)

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

Параметры

object|array|string $classes

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

void

Исключения

RuntimeException

protected void registerObserver(object|string $class)

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

Параметры

object|string $class

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

void

Исключения

RuntimeException

array getObservableEvents()

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

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

array

$this setObservableEvents(array $observables)

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

Параметры

array $observables

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

$this

void addObservableEvents(array|mixed $observables)

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

Параметры

array|mixed $observables

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

void

void removeObservableEvents(array|mixed $observables)

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

Параметры

array|mixed $observables

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

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

статический void created(QueuedClosure|Closure|string|array $callback)

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

Параметры

QueuedClosure|Closure|string|array $callback

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

void

статический void replicating(QueuedClosure|Closure|string|array $callback)

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

Параметры

QueuedClosure|Closure|string|array $callback

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

void

статический void deleting(QueuedClosure|Closure|string|array $callback)

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

Параметры

QueuedClosure|Closure|string|array $callback

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

void

статический void deleted(QueuedClosure|Closure|string|array $callback)

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

Параметры

QueuedClosure|Closure|string|array $callback

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

void

статический void flushEventListeners()

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

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

void

статический Dispatcher getEventDispatcher()

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

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

Dispatcher

статический void setEventDispatcher(Dispatcher $dispatcher)

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

Параметры

Dispatcher $dispatcher

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

void

статический void unsetEventDispatcher()

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

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

void

статический mixed withoutEvents(callable $callback)

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

Параметры

callable $callback

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

mixed

статический mixed addGlobalScope(Scope|Closure|string $scope, Scope|Closure|null $implementation = null)

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

Параметры

Scope|Closure|string $scope
Scope|Closure|null $implementation

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

mixed

Исключения

InvalidArgumentException

статический bool hasGlobalScope(Scope|string $scope)

Определить, имеет ли модель глобальный scope.

Параметры

Scope|string $scope

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

bool

статический Scope|Closure|null getGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Scope|Closure|null

array getGlobalScopes()

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

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

array

mixed relationResolver(string $class, string $key)

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

Параметры

string $class
string $key

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

mixed

статический void resolveRelationUsing(string $name, Closure $callback)

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

Параметры

string $name
Closure $callback

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

void

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

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

Параметры

string $related
string|null $foreignKey
string|null $localKey

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

HasOne
END_OF_DOCUMENT_MARKER

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

Инициализация нового отношения HasOne.

Параметры

Builder $query
Model $parent
string $foreignKey
string $localKey

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

HasOne

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)

Инициализация нового полиморфного отношения MorphOne.

Параметры

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)

Инициализация нового отношения BelongsTo.

Параметры

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
END_OF_DOCUMENT_MARKER

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)

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

Параметры

string $class

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

string

protected string guessBelongsToRelation()

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

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

string

PendingHasThroughRelationship through(string|HasMany|HasOne $relationship)

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

Параметры

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)

Создать новую связь HasMany.

Параметры

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)

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

Параметры

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)

Создать новую связь HasManyThrough.

Параметры

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)

Создать новую связь MorphMany.

Параметры

Builder $query
Model $parent
string $type
string $id
string $localKey

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

MorphMany

BelongsToMany belongsToMany(string $related, 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|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 $table, string $foreignPivotKey, string $relatedPivotKey, string $parentKey, string $relatedKey, string|null $relationName = null)

Инициализация нового отношения BelongsToMany.

Параметры

Builder $query
Model $parent
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string|null $relationName

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

BelongsToMany

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, bool $inverse = false)

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

Параметры

string $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey
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)

Инициализация нового полиморфного отношения MorphToMany.

Параметры

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 $related
string $name
string|null $table
string|null $foreignPivotKey
string|null $relatedPivotKey
string|null $parentKey
string|null $relatedKey

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

MorphToMany

protected string|null guessBelongsToManyRelation()

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

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

string|null

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

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

Параметры

string $related
Model|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)

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

Параметры

array $relations

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

$this

$this withoutRelations()

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

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

$this

$this unsetRelations()

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

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch(string|null $attribute = null)

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

Параметры

string|null $attribute

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

bool

bool touchQuietly(string|null $attribute = null)

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

Параметры

string|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()

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

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

string

bool usesTimestamps()

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

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

bool

string|null getCreatedAtColumn()

Получить имя столбца "created at".

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

string|null

string|null getUpdatedAtColumn()

Получить имя столбца "updated at".

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

string|null

string|null getQualifiedCreatedAtColumn()

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

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

string|null

string|null getQualifiedUpdatedAtColumn()

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

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

string|null

static mixed withoutTimestamps(callable $callback)

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

Параметры

callable $callback

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

mixed

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

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

Параметры

array $models
callable $callback

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

mixed

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

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

Параметры

string|null $class

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

bool

string[] getHidden()

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

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

string[]

$this setHidden(array $hidden)

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

Параметры

array $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()

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

Значение возврата

bool

static mixed unguarded(callable $callback)

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

Параметры

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

$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 $function = null)

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

Параметры

массив|строка $relations
строка $column
строка $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

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

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

Параметры

string $relation
array $relations
string $column
string $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)

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

Параметры

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)

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

Параметры

Модель|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 Интерфейс разрешения подключения getConnectionResolver()

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

Значение возврата

Интерфейс разрешения подключения

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

bool getIncrementing()

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

Значение возврата

bool

$this setIncrementing(bool $value)

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

Параметры

bool $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()

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

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

string

string broadcastChannel()

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

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

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 mixed __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

string __toString()

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

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

string

$this escapeWhenCastingToString(bool $escape = true)

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

Параметры

bool $escape

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

$this

array __sleep()

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

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

array

void __wakeup()

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

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

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Database/Eloquent/Model.html

Spec-Zone.ru

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