Модель
класс Модель реализует 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 |
| $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()
Преобразовать атрибуты модели в массив.
protected array addDateAttributesToArray(array $attributes)
Добавить атрибуты даты в массив атрибутов.
protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить измененные атрибуты в массив атрибутов.
protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)
Добавить преобразованные атрибуты в массив атрибутов.
protected array getArrayableAttributes()
Получить массив атрибутов, которые можно преобразовать в массив.
protected array getArrayableAppends()
Получить все добавляемые значения, которые можно преобразовать в массив.
array relationsToArray()
Получить отношения модели в виде массива.
protected array getArrayableRelations()
Получить массив атрибутов всех отношений, которые можно преобразовать в массив.
protected array getArrayableItems(array $values)
Получить массив атрибутов всех значений, которые можно преобразовать в массив.
mixed getAttribute(string $key)
Получить атрибут из модели.
mixed getAttributeValue(string $key)
Получить простой атрибут (не отношение).
protected mixed getAttributeFromArray(string $key)
Получить атрибут из массива $attributes.
mixed getRelationValue(string $key)
Получить отношение.
protected mixed getRelationshipFromMethod(string $method)
Получить значение отношения из метода.
bool hasGetMutator(string $key)
Определить, существует ли мутатор get для атрибута.
protected mixed mutateAttribute(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора.
protected mixed mutateAttributeForArray(string $key, mixed $value)
Получить значение атрибута с помощью его мутатора для преобразования в массив.
protected mixed castAttribute(string $key, mixed $value)
Преобразовать атрибут к собственному типу PHP.
protected string getCastType(string $key)
Получить тип преобразования для атрибута модели.
$this setAttribute(string $key, mixed $value)
Установить заданный атрибут в модели.
bool hasSetMutator(string $key)
Определить, существует ли мутатор set для атрибута.
protected bool isDateAttribute(string $key)
Определить, является ли заданный атрибут датой или допускает преобразование в дату.
$this fillJsonAttribute(string $key, mixed $value)
Установить заданный атрибут JSON в модели.
protected $this getArrayAttributeWithValue(string $path, string $key, mixed $value)
Получить атрибут-массив с заданным ключом и установленным значением.
protected array getArrayAttributeByKey(string $key)
Получить атрибут-массив по ключу или вернуть пустой массив, если он не установлен.
protected string castAttributeAsJson(string $key, mixed $value)
Преобразовать заданный атрибут в JSON.
protected string asJson(mixed $value)
Кодировать заданное значение в JSON.
mixed fromJson(string $value, bool $asObject = false)
Декодировать заданный JSON обратно в массив или объект.
protected Carbon asDate(mixed $value)
Возвратить метку времени как объект DateTime с временем, установленным в 00:00:00.
protected Carbon asDateTime(mixed $value)
Возвратить метку времени как объект DateTime.
protected bool isStandardDateFormat(string $value)
Определить, соответствует ли заданное значение стандартному формату даты.
string fromDateTime(DateTime|int $value)
Преобразовать DateTime в хранимую строку.
protected int asTimestamp(mixed $value)
Возвратить метку времени как метку времени Unix.
protected string serializeDate(DateTimeInterface $date)
Подготовить дату для сериализации в массив/JSON.
array getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
protected string getDateFormat()
Получить формат дат, хранимых в базе данных.
$this setDateFormat(string $format)
Установить формат даты, используемый моделью.
bool hasCast(string $key, array|string|null $types = null)
Определить, должен ли атрибут быть преобразован в базовый тип.
array getCasts()
Получить массив преобразований.
protected bool isDateCastable(string $key)
Определить, может ли значение быть преобразовано в дату/DateTime для обработки на входе.
protected bool isJsonCastable(string $key)
Определить, может ли значение быть преобразовано в JSON для обработки на входе.
array getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(array $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
mixed|array getOriginal(string|null $key = null, mixed $default = null)
Получить исходные значения атрибутов модели.
$this syncOriginal()
Синхронизировать исходные атрибуты с текущими.
$this syncOriginalAttribute(string $attribute)
Синхронизировать один исходный атрибут со своим текущим значением.
bool isDirty(array|string|null $attributes = null)
Определить, была ли изменена модель или заданный(е) атрибут(ы).
bool isClean(array|string|null $attributes = null)
Определить, остались ли модель или заданный(е) атрибут(ы) неизменными.
массив getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации.
protected bool originalIsNumericallyEquivalent(string $key)
Определить, являются ли новые и старые значения для заданного ключа численно эквивалентными.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
$this setAppends(array $appends)
Установить аксессоры для добавления к массивам модели.
массив getMutatedAttributes()
Получить изменённые атрибуты для данного экземпляра.
static void cacheMutatedAttributes(string $class)
Извлечь и кэшировать все изменённые атрибуты класса.
static protected массив getMutatorMethods(mixed $class)
Получить все методы мутаторов атрибутов.
static void observe(object|string $class)
Зарегистрировать наблюдателя в модели.
массив getObservableEvents()
Получить имена наблюдаемых событий.
$this setObservableEvents(array $observables)
Установить имена наблюдаемых событий.
void addObservableEvents(array|mixed $observables)
Добавить имя наблюдаемого события.
void removeObservableEvents(array|mixed $observables)
Удалить имя наблюдаемого события.
static protected void registerModelEvent(string $event, Closure|string $callback)
Зарегистрировать событие модели с диспетчером.
protected смешанный тип fireModelEvent(string $event, bool $halt = true)
Вызвать заданное событие для модели.
protected смешанный тип|null fireCustomModelEvent(string $event, string $method)
Вызвать пользовательское событие модели для данного события.
protected смешанный тип filterModelEventResults(mixed $result)
Отфильтровать результаты события модели.
static void saving(Closure|string $callback)
Зарегистрировать событие сохранения модели с диспетчером.
static void saved(Closure|string $callback)
Зарегистрировать событие сохранения модели с диспетчером.
static void updating(Closure|string $callback)
Зарегистрировать событие обновления модели с диспетчером.
static void updated(Closure|string $callback)
Зарегистрировать событие обновления модели с диспетчером.
static void creating(Closure|string $callback)
Зарегистрировать событие создания модели с диспетчером.
static void created(Closure|string $callback)
Зарегистрировать событие создания модели в диспетчере.
static void deleting(Closure|string $callback)
Зарегистрировать событие удаления модели в диспетчере.
static void deleted(Closure|string $callback)
Зарегистрировать событие удаления модели в диспетчере.
static void flushEventListeners()
Удалить все обработчики событий для модели.
static Dispatcher getEventDispatcher()
Получить экземпляр диспетчера событий.
static void setEventDispatcher(Dispatcher $dispatcher)
Установить экземпляр диспетчера событий.
static void unsetEventDispatcher()
Удалить диспетчер событий для моделей.
static mixed addGlobalScope(Scope|Closure|string $scope, Closure $implementation = null)
Зарегистрировать новый глобальный scope для модели.
static bool hasGlobalScope(Scope|string $scope)
Определить, имеет ли модель глобальный scope.
static Scope|Closure|null getGlobalScope(Scope|string $scope)
Получить зарегистрированный глобальный scope для модели.
array getGlobalScopes()
Получить глобальные scopes для этого экземпляра класса.
HasOne hasOne(string $related, string $foreignKey = null, string $localKey = null)
Определить отношение один-к-одному.
MorphOne morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
Определить полиморфное отношение один-к-одному.
BelongsTo belongsTo(string $related, string $foreignKey = null, string $ownerKey = null, string $relation = null)
Определить обратное отношение один-к-одному или многие-ко-многим.
MorphTo morphTo(string $name = null, string $type = null, string $id = null)
Определить полиморфное, обратное отношение один-к-одному или многие-ко-многим.
protected MorphTo morphEagerTo(string $name, string $type, string $id)
Определить полиморфное, обратное отношение один-к-одному или многие-ко-многим.
protected MorphTo morphInstanceTo(string $target, string $name, string $type, string $id)
Определить полиморфное, обратное одно-к-одному или многие отношения.
static string getActualClassNameForMorph(string $class)
Получить фактическое имя класса для заданного класса morph.
protected string guessBelongsToRelation()
Угадать имя отношения "belongs to".
HasMany hasMany(string $related, string $foreignKey = null, string $localKey = null)
Определить отношение один-ко-многим.
HasManyThrough hasManyThrough(string $related, string $through, string|null $firstKey = null, string|null $secondKey = null, string|null $localKey = null)
Определить отношение has-many-through.
MorphMany morphMany(string $related, string $name, string $type = null, string $id = null, string $localKey = null)
Определить полиморфное отношение один-ко-многим.
BelongsToMany belongsToMany(string $related, string $table = null, string $foreignKey = null, string $relatedKey = null, string $relation = null)
Определить отношение многие-ко-многим.
MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $relatedKey = null, bool $inverse = false)
Определить полиморфное отношение многие-ко-многим.
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $relatedKey = null)
Определить полиморфное обратное отношение многие-ко-многим.
protected string guessBelongsToManyRelation()
Получить имя связи «многие ко многим».
string joiningTable(string $related)
Получить имя таблицы связи для связи «многие ко многим».
bool touches(string $relation)
Определить, затрагивает ли модель заданную связь.
void touchOwners()
Обновить связанные модели.
protected array getMorphs(string $name, string $type, string $id)
Получить столбцы полиморфной связи.
string getMorphClass()
Получить имя класса для полиморфных связей.
protected mixed newRelatedInstance(string $class)
Создать новый экземпляр модели для связанной модели.
array getRelations()
Получить все загруженные связи для экземпляра.
mixed getRelation(string $relation)
Получить указанное отношение.
bool relationLoaded(string $key)
Определить, загружено ли заданное отношение.
$this setRelation(string $relation, mixed $value)
Установить конкретное отношение в модели.
$this setRelations(array $relations)
Установить весь массив отношений в модели.
array getTouchedRelations()
Получить отношения, которые затрагиваются при сохранении.
$this setTouchedRelations(array $touches)
Установить отношения, которые затрагиваются при сохранении.
bool touch()
Обновить отметку времени последнего обновления модели.
protected void updateTimestamps()
Обновить метки времени создания и обновления.
$this setCreatedAt(mixed $value)
Установить значение атрибута "created at".
$this setUpdatedAt(mixed $value)
Установить значение атрибута "updated at".
Carbon freshTimestamp()
Получить свежую отметку времени для модели.
string freshTimestampString()
Получить свежую отметку времени для модели.
bool usesTimestamps()
Определить, использует ли модель отметки времени.
string getCreatedAtColumn()
Получить имя столбца "created at".
string getUpdatedAtColumn()
Получить имя столбца "updated at".
array getHidden()
Получить скрытые атрибуты модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты модели.
void addHidden(array|string|null $attributes = null)
Добавить скрытые атрибуты модели.
array getVisible()
Получить видимые атрибуты модели.
$this setVisible(array $visible)
Установить видимые атрибуты модели.
void addVisible(array|string|null $attributes = null)
Добавить видимые атрибуты модели.
$this makeVisible(array|string $attributes)
Сделать заданные, обычно скрытые, атрибуты видимыми.
$this makeHidden(array|string $attributes)
Сделать заданные, обычно видимые, атрибуты скрытыми.
array getFillable()
Получить заполняемые атрибуты модели.
$this fillable(array $fillable)
Установить заполняемые атрибуты модели.
array getGuarded()
Получить защищенные атрибуты модели.
$this guard(array $guarded)
Установить защищаемые атрибуты для модели.
static void unguard(bool $state = true)
Отключить все ограничения массового назначения.
static void reguard()
Включить ограничения массового назначения.
static bool isUnguarded()
Определить, находится ли текущее состояние в режиме "unguarded".
static mixed unguarded(callable $callback)
Выполнить заданный вызов с отключенными ограничениями массового назначения.
bool isFillable(string $key)
Определить, может ли данный атрибут быть массово назначенным.
bool isGuarded(string $key)
Определить, является ли данный ключ защищенным.
bool totallyGuarded()
Определить, полностью ли защищена модель.
protected array fillableFromArray(array $attributes)
Получить заполняемые атрибуты из данного массива.
void __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent.
protected void bootIfNotBooted()
Проверить, нужна ли загрузка модели, и если да, то загрузить ее.
static protected void boot()
Метод "загрузки" модели.
static protected void bootTraits()
Загрузить все загружаемые трейты модели.
static void clearBootedModels()
Очистить список загруженных моделей, чтобы они были загружены заново.
$this fill(array $attributes)
Заполнить модель массивом атрибутов.
$this forceFill(array $attributes)
Заполнить модель массивом атрибутов. Принудительно назначить массив.
protected 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()
Начать запросы к модели на соединении для записи.
статический Builder|Модель with(массив|строка $relations)
Начать запрос к модели с леничной загрузкой.
$this load(массив|строка $relations)
Ленично загрузить связи модели.
защищённый целое число increment(строка $column, целое число $amount = 1, массив $extra = [])
Увеличить значение столбца на заданную величину.
защищённый целое число decrement(строка $column, целое число $amount = 1, массив $extra = [])
Уменьшить значение столбца на заданную величину.
защищённый целое число incrementOrDecrement(строка $column, целое число $amount, массив $extra, строка $method)
Выполнить метод увеличения или уменьшения на модели.
защищённый void incrementOrDecrementAttributeValue(строка $column, целое число $amount, массив $extra, строка $method)
Увеличить или уменьшить базовое значение атрибута и синхронизировать с оригиналом.
bool update(массив $attributes = [], массив $options = [])
Обновить модель в базе данных.
bool push()
Сохранить модель и все её связи.
bool save(массив $options = [])
Сохранить модель в базе данных.
bool saveOrFail(массив $options = [])
Сохранить модель в базе данных с использованием транзакции.
защищённый void finishSave(массив $options)
Выполнить любые действия, необходимые после сохранения модели.
защищённый bool performUpdate(Builder $query)
Выполнить операцию обновления модели.
защищённый смешанный getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения.
защищённый bool performInsert(Builder $query)
Выполнить операцию вставки модели.
защищённый void insertAndSetId(Builder $query, массив $attributes)
Вставить заданные атрибуты и установить ID на модели.
статический целое число destroy(массив|целое число $ids)
Удалить модели для заданных ID.
bool|null delete()
Удалить модель из базы данных.
bool|null forceDelete()
Выполнить жёсткое удаление мягко удалённой модели.
Этот метод защищает разработчиков от запуска forceDelete, когда трейт отсутствует.
защищённый void performDeleteOnModel()
Выполнить фактический запрос удаления для этого экземпляра модели.
static Builder query()
Начать запросы к модели.
Builder newQuery()
Получить новый конструктор запросов для таблицы модели.
Builder|Модель newQueryWithoutScopes()
Получить новый конструктор запросов без глобальных обработчиков.
Builder newQueryWithoutScope(Обработчик|string $scope)
Получить новый экземпляр запроса без заданного обработчика.
Builder|Модель newEloquentBuilder(Builder $query)
Создать новый Eloquent конструктор запросов для модели.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр конструктора запросов для подключения.
Коллекция newCollection(array $models = [])
Создать новый экземпляр Eloquent коллекции.
Pivot newPivot(Модель $parent, array $attributes, string $table, bool $exists, string|null $using = null)
Создать новый экземпляр модели pivot.
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()
При десериализации модели проверить, нужно ли ее запустить.
© 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