Spec-Zone.ru › Laravel 5.5

Модель

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

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

Имя столбца "created at".

UPDATED_AT

Имя столбца "updated at".

Свойства

protected массив $attributes Атрибуты модели. из HasAttributes
protected массив $original Исходное состояние атрибутов модели. из HasAttributes
protected массив $changes Измененные атрибуты модели. из HasAttributes
protected массив $casts Атрибуты, которые должны быть преобразованы к собственным типам. из HasAttributes
protected массив $dates Атрибуты, которые должны быть преобразованны в даты. из HasAttributes
protected строка $dateFormat Формат хранения столбцов дат модели. из HasAttributes
protected массив $appends Акцессоры для добавления в массив формы модели. из HasAttributes
static bool $snakeAttributes Указывает, должны ли атрибуты быть преобразованны в snake_case для массивов. из HasAttributes
static protected массив $mutatorCache Кэш мутированных атрибутов для каждого класса. из HasAttributes
protected массив $dispatchesEvents Карта событий для модели. из HasEvents
protected массив $observables События-наблюдатели, доступные пользователю. из HasEvents
protected массив $relations Загруженные отношения для модели. из HasRelationships
protected массив $touches Отношения, которые должны быть изменены при сохранении. из HasRelationships
static массив $manyMethods Методы для отношений "многие ко многим". из HasRelationships
bool $timestamps Указывает, должна ли модель использовать метки времени. из HasTimestamps
protected массив $hidden Атрибуты, которые должны быть скрыты при сериализации. из HidesAttributes
protected массив $visible Атрибуты, которые должны быть видны при сериализации. из HidesAttributes
protected массив $fillable Атрибуты, которые допускают массовое назначение. из GuardsAttributes
protected массив $guarded Атрибуты, которые не допускают массового назначения. из GuardsAttributes
static protected bool $unguarded Указывает, разрешено ли все массовое назначение. из GuardsAttributes
protected строка $connection Имя подключения для модели.
protected строка $table Таблица, связанная с моделью.
protected строка $primaryKey Первичный ключ для модели.
protected строка $keyType Тип автоинкрементного ID.
bool $incrementing Указывает, являются ли ID автоинкрементными.
protected массив $with Отношения, которые следует загрузить при каждом запросе.
protected массив $withCount Подсчеты отношений, которые следует загрузить при каждом запросе.
protected целое число $perPage Количество моделей, возвращаемых при постраничном отображении.
bool $exists Указывает, существует ли модель.
bool $wasRecentlyCreated Указывает, была ли модель вставлена во время текущего цикла запроса.
static protected ConnectionResolverInterface $resolver Экземпляр резолвера подключения.
static protected Dispatcher $dispatcher Экземпляр диспетчера событий.
static protected массив $booted Массив запущенных моделей.
static protected массив $globalScopes Массив глобальных областей действия модели.

Методы

массив 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
смешанное getAttributeValue(строка $key)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из HasAttributes
$this setAttribute(строка $key, смешанное $value)

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

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

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

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

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

из HasAttributes
$this fillJsonAttribute(строка $key, смешанное $value)

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

из HasAttributes
$this getArrayAttributeWithValue(строка $path, строка $key, смешанное $value)

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

из HasAttributes
массив getArrayAttributeByKey(строка $key)

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

из HasAttributes
строка castAttributeAsJson(строка $key, смешанное $value)

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

из HasAttributes
строка asJson(смешанное $value)

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

из HasAttributes
смешанное fromJson(строка $value, логическое $asObject = ложь)

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

из HasAttributes
Carbon asDate(смешанное $value)

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

из HasAttributes
Carbon asDateTime(mixed $value)

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

из HasAttributes
bool isStandardDateFormat(string $value)

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

из HasAttributes
string fromDateTime(DateTime|int $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)

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

из HasAttributes
bool isJsonCastable(string $key)

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

из HasAttributes
array getAttributes()

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

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

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

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

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

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

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

из HasAttributes
$this syncOriginal()

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

из HasAttributes
$this syncOriginalAttribute(string $attribute)

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

из HasAttributes
$this syncChanges()

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

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

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

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

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

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

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

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

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

из HasAttributes
$this setAppends(array $appends)

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

из HasAttributes
array getMutatedAttributes()

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

из HasAttributes
static void cacheMutatedAttributes(string $class)

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

from HasAttributes
static array getMutatorMethods(mixed $class)

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

from HasAttributes
static void observe(object|string $class)

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

from HasEvents
array getObservableEvents()

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

from HasEvents
$this setObservableEvents(array $observables)

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

from HasEvents
void addObservableEvents(array|mixed $observables)

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

from HasEvents
void removeObservableEvents(array|mixed $observables)

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

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

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

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

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

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

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

from HasEvents
mixed filterModelEventResults(mixed $result)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasEvents
static void flushEventListeners()

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

from HasEvents
static Dispatcher getEventDispatcher()

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

from HasEvents
static void setEventDispatcher(Dispatcher $dispatcher)

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

from HasEvents
static void unsetEventDispatcher()

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

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

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

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

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

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

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

from HasGlobalScopes
array getGlobalScopes()

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

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

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

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

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

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

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

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

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

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

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

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

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

Угадать имя отношения «принадлежит к».

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

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

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

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

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

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

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

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

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

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

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

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

from HasRelationships
string guessBelongsToManyRelation()

Получить имя отношения «принадлежит ко многим».

from HasRelationships
string joiningTable(string $related)

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

from HasRelationships
bool touches(string $relation)

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

from HasRelationships
void touchOwners()

Затронуть владеющие отношения модели.

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

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

from HasRelationships
string getMorphClass()

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

from HasRelationships
mixed newRelatedInstance(string $class)

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

from HasRelationships
array getRelations()

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

from HasRelationships
mixed getRelation(string $relation)

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

from HasRelationships
bool relationLoaded(string $key)

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

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

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

from HasRelationships
$this setRelations(array $relations)

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

from HasRelationships
array getTouchedRelations()

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

from HasRelationships
$this setTouchedRelations(array $touches)

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

from HasRelationships
bool touch()

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

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

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

from HasTimestamps
string getUpdatedAtColumn()

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

from HasTimestamps
array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

from HidesAttributes
void addHidden(array|string|null $attributes = null)

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

from HidesAttributes
void addVisible(array|string|null $attributes = null)

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

from HidesAttributes
$this makeVisible(array|string $attributes)

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

from HidesAttributes
$this makeHidden(array|string $attributes)

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(array $guarded)

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

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

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

from GuardsAttributes
static void reguard()

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

from GuardsAttributes
static bool isUnguarded()

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

from GuardsAttributes
static mixed unguarded(callable $callback)

Выполнить заданный вызов, находясь в режиме "unguarded".

from GuardsAttributes
bool isFillable(string $key)

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

from GuardsAttributes
bool isGuarded(string $key)

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

from GuardsAttributes
bool totallyGuarded()

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

from GuardsAttributes
array fillableFromArray(array $attributes)

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

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

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

void bootIfNotBooted()

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

static void boot()

Метод "загрузки" модели.

static void bootTraits()

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

static void clearBootedModels()

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

$this fill(array $attributes)

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

$this forceFill(array $attributes)

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

string removeTableFromKey(string $key)

Удалить имя таблицы из заданного ключа.

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|Model[] all(array|mixed $columns = ['*'])

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

static Builder|Model with(array|string $relations)

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

$this load(array|string $relations)

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

$this loadMissing(array|string $relations)

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

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

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

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

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

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

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

void incrementOrDecrementAttributeValue(string $column, int $amount, array $extra, string $method)

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

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

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

bool push()

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

bool save(array $options = [])

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

bool saveOrFail(array $options = [])

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

void finishSave(array $options)

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

bool performUpdate(Builder $query)

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

Builder setKeysForSaveQuery(Builder $query)

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

mixed getKeyForSaveQuery()

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

bool performInsert(Builder $query)

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

void insertAndSetId(Builder $query, array $attributes)

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

static int destroy(array|int $ids)

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

bool|null delete()

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

bool|null forceDelete()

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

void performDeleteOnModel()

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

static Builder query()

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

Builder newQuery()

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

Builder|Model newQueryWithoutScopes()

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

Builder newQueryWithoutScope(Scope|string $scope)

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

Builder|Model newEloquentBuilder(Builder $query)

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

Builder newBaseQueryBuilder()

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

Collection newCollection(array $models = [])

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

Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists, string|null $using = null)

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

array toArray()

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

string toJson(int $options)

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

array jsonSerialize()

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

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

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

$this refresh()

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

Model replicate(array $except = null)

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

bool is(Model|null $model)

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

bool isNot(Model|null $model)

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

Connection getConnection()

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

string getConnectionName()

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

$this setConnection(string $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()

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

string|null getQueueableConnection()

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

mixed getRouteKey()

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

string getRouteKeyName()

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

Model|null resolveRouteBinding(mixed $value)

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

string getForeignKey()

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

int getPerPage()

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

$this setPerPage(int $perPage)

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

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

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

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

mixed getAttributeValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getAttributeFromArray(string $key)

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

Параметры

string $key

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

mixed

mixed getRelationValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getRelationshipFromMethod(string $method)

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

Параметры

string $method

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

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

protected string getCastType(string $key)

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

Параметры

string $key

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

string

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

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

Параметры

string $key
mixed $value

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

$this

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

protected bool isDateAttribute(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

$this

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

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

Параметры

string $path
string $key
mixed $value

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

$this

protected array getArrayAttributeByKey(string $key)

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

Параметры

string $key

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

array

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

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

Параметры

string $key
mixed $value

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

string

protected string asJson(mixed $value)

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

Параметры

mixed $value

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

string

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

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

Параметры

string $value
bool $asObject

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

mixed

protected Carbon asDate(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected bool isStandardDateFormat(string $value)

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

Параметры

string $value

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

bool

string fromDateTime(DateTime|int $value)

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

Параметры

DateTime|int $value

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

string

protected int asTimestamp(mixed $value)

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

Параметры

mixed $value

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

int

protected string serializeDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface $date

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

string

array getDates()

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

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

array

protected string getDateFormat()

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

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

string

$this setDateFormat(string $format)

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

Параметры

string $format

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

$this

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

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

Параметры

string $key
array|string|null $types

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

bool

array getCasts()

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

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

array

protected bool isDateCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isJsonCastable(string $key)

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

Параметры

string $key

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

bool

array getAttributes()

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

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

array

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

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

Параметры

array $attributes
bool $sync

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

$this

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

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

Параметры

string|null $key
mixed $default

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

mixed|array

array only(array|mixed $attributes)

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

Параметры

array|mixed $attributes

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

array

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

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

$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

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

protected bool originalIsEquivalent(string $key, mixed $current)

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

Параметры

string $key
mixed $current

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

bool

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

array getMutatedAttributes()

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

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

array

static void cacheMutatedAttributes(string $class)

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

Параметры

string $class

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

void

static protected array getMutatorMethods(mixed $class)

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

Параметры

mixed $class

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

array

static void observe(object|string $class)

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

Параметры

object|string $class

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

void

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, Closure|string $callback)

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

Параметры

string $event
Closure|string $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(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void saving(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void saved(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updated(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void created(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleting(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleted(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void flushEventListeners()

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

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

void

static Dispatcher getEventDispatcher()

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

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

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Параметры

Dispatcher $dispatcher

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

void

static void unsetEventDispatcher()

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

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

void

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

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

Параметры

Scope|Closure|string $scope
Closure $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

массив getGlobalScopes()

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

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

массив

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasOne

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

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

Параметры

string $related
string $name
string $type
string $id
string $localKey

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

MorphOne

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

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

Параметры

string $related
string $foreignKey
string $ownerKey
string $relation

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

BelongsTo

MorphTo morphTo(string $name = null, string $type = null, string $id = null)

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

Параметры

string $name
string $type
string $id

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

MorphTo

защищено MorphTo morphEagerTo(string $name, string $type, string $id)

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

Параметры

string $name
string $type
string $id

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

MorphTo

защищено MorphTo morphInstanceTo(string $target, string $name, string $type, string $id)

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

Параметры

string $target
string $name
string $type
string $id

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

MorphTo

статично string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

защищено string guessBelongsToRelation()

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

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

string

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

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

Параметры

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

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

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

Параметры

string $related
string $name
string $type
string $id
string $localKey

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

MorphMany
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $related
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
string $relation

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

BelongsToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey
bool $inverse

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

MorphToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignPivotKey
string $relatedPivotKey
string $parentKey
string $relatedKey

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

MorphToMany

protected string guessBelongsToManyRelation()

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

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

string

string joiningTable(string $related)

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

Параметры

string $related

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

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

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

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

Параметры

array $relations

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

$this

array getTouchedRelations()

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

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

array

$this setTouchedRelations(array $touches)

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

Параметры

array $touches

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

$this

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

$this setCreatedAt(mixed $value)

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

Параметры

mixed $value

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

$this
END_OF_DOCUMENT_MARKER

$this setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

$this

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

bool usesTimestamps()

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

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

bool

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

string

array getHidden()

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

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

array

$this setHidden(array $hidden)

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

Параметры

array $hidden

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

$this

void addHidden(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

array getVisible()

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

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

array

$this setVisible(array $visible)

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

Параметры

array $visible

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

$this

void addVisible(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

void

$this makeVisible(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this makeHidden(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

Выполнить заданный вызываемый объект в режиме "unguarded".

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

void __construct(array $attributes = [])

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

Параметры

array $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

Метод "запуска" модели.

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

void

static protected void bootTraits()

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

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

void

static void clearBootedModels()

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

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

void

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

array $attributes

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

$this

protected string removeTableFromKey(string $key)

Удалить имя таблицы из заданного ключа.

Параметры

string $key

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

string

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

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

Параметры

array $attributes
bool $exists

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

Model

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

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

Параметры

array $attributes
string|null $connection

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

Model

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

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

Параметры

string|null $connection

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

Builder

static Builder onWriteConnection()

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

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

Builder

static Collection|Model[] all(array|mixed $columns = ['*'])

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

Параметры

array|mixed $columns

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

Collection|Model[]

static Builder|Model with(array|string $relations)

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

Параметры

array|string $relations

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

Builder|Model

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

$this loadMissing(array|string $relations)

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

Параметры

array|string $relations

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

$this

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

Выполнить метод увеличения или уменьшения для модели.

Параметры

string $column
int $amount
array $extra
string $method

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

int

protected void incrementOrDecrementAttributeValue(string $column, int $amount, array $extra, string $method)

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

Параметры

string $column
int $amount
array $extra
string $method

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

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

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

Исключения

Exception

bool|null forceDelete()

Принудительно удалить мягко удалённую модель.

Этот метод защищает разработчиков от запуска forceDelete, когда отсутствует trait.

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder

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

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

Параметры

массив $models

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

Коллекция

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

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

Параметры

Модель $parent
массив $attributes
строка $table
логическое $exists
строка|null $using

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

Связь

массив toArray()

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

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

массив

строка toJson(int $options)

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

Параметры

int $options

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

строка

Исключения

ИсключениеJSON

массив jsonSerialize()

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

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

массив

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

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

Параметры

массив|строка $with

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

Модель|null

$this refresh()

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

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

$this

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

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

Параметры

массив $except

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

Модель

логическое is(Модель|null $model)

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

Параметры

Модель|null $model

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

логическое

логическое isNot(Модель|null $model)

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

Параметры

Модель|null $model

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

логическое

Соединение getConnection()

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

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

Соединение

строка getConnectionName()

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

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

строка

$this setConnection(string $name)

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

Параметры

строка $name

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

$this

static Соединение resolveConnection(string|null $connection = null)

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

Параметры

строка|null $connection

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

Соединение

static Интерфейс разрешения соединения getConnectionResolver()

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

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

Интерфейс разрешения соединения

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

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

Параметры

Интерфейс разрешения соединения $resolver

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

void

static void unsetConnectionResolver()

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

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

void

строка getTable()

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

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

строка

$this setTable(string $table)

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

Параметры

строка $table

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

$this

строка getKeyName()

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

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

строка

$this setKeyName(string $key)

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

Параметры

строка $key

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

$this

string getQualifiedKeyName()

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

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

string

string getKeyType()

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

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

string

$this setKeyType(string $type)

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

Параметры

string $type

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

$this

bool getIncrementing()

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

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

bool

$this setIncrementing(bool $value)

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

Параметры

bool $value

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

$this

mixed getKey()

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

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

mixed

mixed getQueueableId()

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

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

mixed

string|null getQueueableConnection()

Получить соединение очереди для сущности.

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

string|null

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

Model|null resolveRouteBinding(mixed $value)

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

Параметры

mixed $value

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

Model|null

string getForeignKey()

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

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

string

int getPerPage()

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

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

int

$this setPerPage(int $perPage)

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

Параметры

int $perPage

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

$this

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

void __wakeup()

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

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

void

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

Spec-Zone.ru

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