Spec-Zone.ru › Laravel 5.4

Модель

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

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

protected массив $attributes Атрибуты модели. из HasAttributes
protected массив $original Исходное состояние атрибутов модели. из HasAttributes
protected массив $casts Атрибуты, которые должны быть преобразованы в базовые типы. из HasAttributes
protected массив $dates Атрибуты, которые должны быть преобразованы в даты. из HasAttributes
protected строка $dateFormat Формат хранения столбцов даты модели. из HasAttributes
protected массив $appends Акцессоры, которые должны быть добавлены к массиву модели. из HasAttributes
static bool $snakeAttributes Указывает, преобразуются ли атрибуты в snake_case в массивах. из HasAttributes
static protected массив $mutatorCache Кэш мутированных атрибутов для каждого класса. из HasAttributes
protected массив $events Карта событий для модели. из 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-метку времени.

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

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

из HasAttributes
$this syncOriginalAttribute(string $attribute)

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

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

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

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

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

из HasAttributes
array getDirty()

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

из HasAttributes
bool originalIsNumericallyEquivalent(string $key)

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

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

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

из HasAttributes
$this setAppends(array $appends)

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

из HasAttributes
array getMutatedAttributes()

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

из HasAttributes
static void cacheMutatedAttributes(string $class)

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

из HasAttributes
static array getMutatorMethods(mixed $class)

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

из HasAttributes
static void observe(object|string $class)

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

из HasEvents
array getObservableEvents()

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

из HasEvents
$this setObservableEvents(array $observables)

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

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

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

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)

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

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

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

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

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

из HasRelationships
static string getActualClassNameForMorph(string $class)

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

из HasRelationships
string guessBelongsToRelation()

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

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

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

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

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

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

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

из HasRelationships
BelongsToMany belongsToMany(string $related, string $table = null, string $foreignKey = null, string $relatedKey = null, string $relation = null)

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

из HasRelationships
MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $relatedKey = null, bool $inverse = false)

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

из HasRelationships
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $relatedKey = null)

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

из HasRelationships
string guessBelongsToManyRelation()

Получить имя отношения belongs to many.

из HasRelationships
string joiningTable(string $related)

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

из 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
array getRelations()

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

из HasRelationships
mixed getRelation(string $relation)

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

из HasRelationships
bool relationLoaded(string $key)

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

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

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

из HasRelationships
$this setRelations(array $relations)

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

из HasRelationships
array getTouchedRelations()

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

из HasRelationships
$this setTouchedRelations(array $touches)

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

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

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

from GuardsAttributes
static mixed unguarded(callable $callback)

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

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)

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

Модель newInstance(array $attributes = [], bool $exists = false)

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

Модель newFromBuilder(array $attributes = [], string|null $connection = null)

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

static Билдер on(string|null $connection = null)

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

static Билдер onWriteConnection()

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

static Коллекция|Модель[] all(array|mixed $columns = ['*'])

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

static Билдер|Модель with(array|string $relations)

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

$this load(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(Билдер $query)

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

Билдер setKeysForSaveQuery(Билдер $query)

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

mixed getKeyForSaveQuery()

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

bool performInsert(Билдер $query)

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

void insertAndSetId(Билдер $query, array $attributes)

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

static int destroy(array|int $ids)

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

bool|null delete()

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

bool|null forceDelete()

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

void performDeleteOnModel()

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

static Билдер query()

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

Билдер newQuery()

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

Билдер|Модель newQueryWithoutScopes()

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

Билдер newQueryWithoutScope(Scope|string $scope)

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

Билдер|Модель newEloquentBuilder(Билдер $query)

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

Билдер newBaseQueryBuilder()

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

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

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

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

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

array toArray()

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

string toJson(int $options)

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

array jsonSerialize()

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

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

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

$this refresh()

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

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

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

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

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

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

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

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

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

string getConnectionName()

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

$this setConnection(string $name)

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

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

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

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

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

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

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

static void unsetConnectionResolver()

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

string getTable()

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

$this setTable(string $table)

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

string getKeyName()

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

$this setKeyName(string $key)

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

string getQualifiedKeyName()

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

string getKeyType()

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

$this setKeyType(string $type)

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

bool getIncrementing()

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

$this setIncrementing(bool $value)

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

mixed getKey()

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

mixed getQueueableId()

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

mixed getRouteKey()

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

string getRouteKeyName()

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

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)

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

Параметры

массив $attributes
массив $mutatedAttributes

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

массив

protected array getArrayableAttributes()

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

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

массив

protected array getArrayableAppends()

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

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

массив

array relationsToArray()

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

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

массив

protected array getArrayableRelations()

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

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

массив

protected array getArrayableItems(array $values)

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

Параметры

массив $values

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

массив

mixed getAttribute(string $key)

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

Параметры

строка $key

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

смешанное

mixed getAttributeValue(string $key)

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

Параметры

строка $key

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

смешанное

protected mixed getAttributeFromArray(string $key)

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

Параметры

строка $key

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

смешанное

mixed getRelationValue(string $key)

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

Параметры

строка $key

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

смешанное

protected mixed getRelationshipFromMethod(string $method)

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

Параметры

строка $method

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

смешанное

Исключения

LogicException

bool hasGetMutator(string $key)

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

Параметры

строка $key

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

bool

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

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

Параметры

строка $key
смешанное $value

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

смешанное

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

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

Параметры

строка $key
смешанное $value

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

смешанное

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

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

Параметры

строка $key
смешанное $value

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

смешанное

protected string getCastType(string $key)

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

Параметры

строка $key

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

строка

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

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

Параметры

строка $key
смешанное $value

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

$this

bool hasSetMutator(string $key)

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

Параметры

строка $key

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

bool

protected bool isDateAttribute(string $key)

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

Параметры

строка $key

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

bool

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

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

Параметры

строка $key
смешанное $value

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

$this

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

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

Параметры

строка $path
строка $key
смешанное $value

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

$this

protected array getArrayAttributeByKey(string $key)

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

Параметры

строка $key

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

массив

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

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

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

$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

массив getDirty()

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

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

массив

protected bool originalIsNumericallyEquivalent(string $key)

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

Параметры

строка $key

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

bool

$this append(array|string $attributes)

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

Параметры

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

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

$this

$this setAppends(array $appends)

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

Параметры

массив $appends

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

$this

массив getMutatedAttributes()

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

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

массив

static void cacheMutatedAttributes(string $class)

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

Параметры

строка $class

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

void

static protected массив getMutatorMethods(mixed $class)

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

Параметры

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

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

массив

static void observe(object|string $class)

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

Параметры

объект|строка $class

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

void

массив getObservableEvents()

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

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

массив

$this setObservableEvents(array $observables)

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

Параметры

массив $observables

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

$this

void addObservableEvents(array|mixed $observables)

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

Параметры

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

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

void

void removeObservableEvents(array|mixed $observables)

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

Параметры

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

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

void

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

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

Параметры

строка $event
Closure|строка $callback

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

void

protected смешанный тип fireModelEvent(string $event, bool $halt = true)

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

Параметры

строка $event
bool $halt

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

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

protected смешанный тип|null fireCustomModelEvent(string $event, string $method)

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

Параметры

строка $event
строка $method

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

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

protected смешанный тип filterModelEventResults(mixed $result)

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

Параметры

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

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

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

static void saving(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void saved(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void updating(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void updated(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|строка $callback

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

void

static void created(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void deleting(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void deleted(Closure|string $callback)

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

Parameters

Closure|string $callback

Return Value

void

static void flushEventListeners()

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

Return Value

void

static Dispatcher getEventDispatcher()

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

Return Value

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Parameters

Dispatcher $dispatcher

Return Value

void

static void unsetEventDispatcher()

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

Return Value

void

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

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

Parameters

Scope|Closure|string $scope
Closure $implementation

Return Value

mixed

Exceptions

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Parameters

Scope|string $scope

Return Value

bool

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

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

Parameters

Scope|string $scope

Return Value

Scope|Closure|null

array getGlobalScopes()

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

Return Value

array

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

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

Parameters

string $related
string $foreignKey
string $localKey

Return Value

HasOne

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

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

Parameters

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

Return Value

MorphOne

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

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

Parameters

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

Return Value

BelongsTo

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

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

Parameters

string $name
string $type
string $id

Return Value

MorphTo

protected MorphTo morphEagerTo(string $name, string $type, string $id)

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

Parameters

string $name
string $type
string $id

Return Value

MorphTo

protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id)

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

Параметры

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

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

MorphTo

static string getActualClassNameForMorph(string $class)

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

Параметры

string $class

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

string

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

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

Параметры

string $related
string $through
string|null $firstKey
string|null $secondKey
string|null $localKey

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

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

BelongsToMany belongsToMany(string $related, string $table = null, string $foreignKey = null, string $relatedKey = null, string $relation = null)

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

Параметры

string $related
string $table
string $foreignKey
string $relatedKey
string $relation

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

BelongsToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignKey
string $relatedKey
bool $inverse

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

MorphToMany

MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $relatedKey = null)

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

Параметры

string $related
string $name
string $table
string $foreignKey
string $relatedKey

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

MorphToMany
END_OF_DOCUMENT_MARKER

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

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

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

Parameters

array $guarded

Return Value

$this

static void unguard(bool $state = true)

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

Parameters

bool $state

Return Value

void

static void reguard()

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

Return Value

void

static bool isUnguarded()

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

Return Value

bool

static mixed unguarded(callable $callback)

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

Parameters

callable $callback

Return Value

mixed

bool isFillable(string $key)

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

Parameters

string $key

Return Value

bool

bool isGuarded(string $key)

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

Parameters

string $key

Return Value

bool

bool totallyGuarded()

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

Return Value

bool

protected array fillableFromArray(array $attributes)

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

Parameters

array $attributes

Return Value

array

void __construct(array $attributes = [])

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

Parameters

array $attributes

Return Value

void

protected void bootIfNotBooted()

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

Return Value

void

static protected void boot()

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

Return Value

void

static protected void bootTraits()

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

Return Value

void

static void clearBootedModels()

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

Return Value

void

$this fill(array $attributes)

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

Parameters

array $attributes

Return Value

$this

Exceptions

MassAssignmentException

$this forceFill(array $attributes)

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

Parameters

array $attributes

Return Value

$this

protected string removeTableFromKey(string $key)

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

Parameters

string $key

Return Value

string

Модель newInstance(array $attributes = [], bool $exists = false)

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

Parameters

array $attributes
bool $exists

Return Value

Модель

Модель newFromBuilder(array $attributes = [], string|null $connection = null)

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

Parameters

array $attributes
string|null $connection

Return Value

Модель

static Билдер on(string|null $connection = null)

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

Parameters

string|null $connection

Return Value

Билдер

static Билдер onWriteConnection()

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

Return Value

Билдер

static Коллекция|Модель[] all(array|mixed $columns = ['*'])

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

Parameters

array|mixed $columns

Return Value

Коллекция|Модель[]

статический Builder|Модель with(массив|строка $relations)

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

Параметры

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

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

Builder|Модель

$this load(массив|строка $relations)

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

Параметры

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

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

$this

защищённый целое число increment(строка $column, целое число $amount = 1, массив $extra = [])

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

Параметры

строка $column
целое число $amount
массив $extra

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

целое число

защищённый целое число decrement(строка $column, целое число $amount = 1, массив $extra = [])

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

Параметры

строка $column
целое число $amount
массив $extra

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

целое число

защищённый целое число incrementOrDecrement(строка $column, целое число $amount, массив $extra, строка $method)

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

Параметры

строка $column
целое число $amount
массив $extra
строка $method

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

целое число

защищённый void incrementOrDecrementAttributeValue(строка $column, целое число $amount, массив $extra, строка $method)

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

Параметры

строка $column
целое число $amount
массив $extra
строка $method

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

void

bool update(массив $attributes = [], массив $options = [])

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

Параметры

массив $attributes
массив $options

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

bool

bool push()

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

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

bool

bool save(массив $options = [])

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

Параметры

массив $options

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

bool

bool saveOrFail(массив $options = [])

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

Параметры

массив $options

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

bool

Исключения

Throwable

защищённый void finishSave(массив $options)

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

Параметры

массив $options

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

void

защищённый bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

защищённый Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

защищённый смешанный getKeyForSaveQuery()

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

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

смешанный

защищённый bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

защищённый void insertAndSetId(Builder $query, массив $attributes)

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

Параметры

Builder $query
массив $attributes

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

void

статический целое число destroy(массив|целое число $ids)

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

Параметры

массив|целое число $ids

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

целое число

bool|null delete()

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

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

bool|null

Исключения

Исключение

bool|null forceDelete()

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

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

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

bool|null

защищённый void performDeleteOnModel()

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

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

void
END_OF_DOCUMENT_MARKER

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Модель newQueryWithoutScopes()

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

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

Builder|Модель

Builder newQueryWithoutScope(Обработчик|string $scope)

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

Параметры

Обработчик|string $scope

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

Builder

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

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

Параметры

Builder $query

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

Builder|Модель

protected Builder newBaseQueryBuilder()

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

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

Builder

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

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

Параметры

array $models

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

Коллекция

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

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

Параметры

Модель $parent
array $attributes
string $table
bool $exists
string|null $using

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

Pivot

array toArray()

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

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

array

string toJson(int $options)

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

Параметры

int $options

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

string

Исключения

JsonEncodingException

array jsonSerialize()

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

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

array

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

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

Параметры

array|string $with

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

Модель|null

$this refresh()

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

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

$this

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

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

Параметры

array $except

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

Модель

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

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

Параметры

Модель $model

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

bool

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

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

Параметры

Модель $model

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

bool

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

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

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

Подключение

string getConnectionName()

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

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

string

$this setConnection(string $name)

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

Параметры

string $name

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

$this

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

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

Параметры

string|null $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

string getTable()

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

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

string

$this setTable(string $table)

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

Параметры

string $table

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

$this

string getKeyName()

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

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

string

$this setKeyName(string $key)

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

Параметры

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

mixed getRouteKey()

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

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

mixed

string getRouteKeyName()

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

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

string

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.4/Illuminate/Database/Eloquent/Model.html

Spec-Zone.ru

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