Модель
класс Модель реализует ArrayAccess, Arrayable, Jsonable, JsonSerializable, QueueableEntity, UrlRoutable (Просмотреть исходный код)
Константы
| CREATED_AT | Имя столбца "создано в". |
| UPDATED_AT | Имя столбца "обновлено в". |
Свойства
| protected string | $connection | Имя подключения для модели. | |
| protected string | $table | Таблица, связанная с моделью. | |
| protected string | $primaryKey | Первичный ключ модели. | |
| protected string | $keyType | Тип автоинкрементируемого ID. | |
| protected int | $perPage | Количество моделей для возврата при постраничном отображении. | |
| bool | $incrementing | Указывает, являются ли ID автоинкрементируемыми. | |
| bool | $timestamps | Указывает, должна ли модель иметь метки времени. | |
| protected array | $attributes | Атрибуты модели. | |
| protected array | $original | Исходное состояние атрибутов модели. | |
| protected array | $relations | Загруженные отношения для модели. | |
| $hidden | Атрибуты, которые следует скрывать для массивов. | ||
| protected array | $visible | Атрибуты, которые следует отображать в массивах. | |
| protected array | $appends | Методы доступа для добавления к массиву модели. | |
| protected array | $fillable | Атрибуты, которые можно массово присваивать. | |
| protected array | $guarded | Атрибуты, которые нельзя массово присваивать. | |
| protected array | $dates | Атрибуты, которые следует преобразовывать в даты. | |
| protected string | $dateFormat | Формат хранения столбцов даты модели. | |
| protected array | $casts | Атрибуты, которые следует преобразовать в базовые типы. | |
| protected array | $touches | Отношения, которые следует изменять при сохранении. | |
| protected array | $observables | Доступные пользователю события наблюдения. | |
| protected array | $with | Отношения для ленивой загрузки при каждом запросе. | |
| protected string | $morphClass | Имя класса, используемого в полиморфных отношениях. | |
| bool | $exists | Указывает, существует ли модель. | |
| bool | $wasRecentlyCreated | Указывает, была ли модель вставлена в текущем цикле запроса. | |
| static bool | $snakeAttributes | Указывает, являются ли атрибуты в нижнем регистре с дефисами. | |
| static protected ConnectionResolverInterface | $resolver | Экземпляр разрешителя подключения. | |
| static protected Dispatcher | $dispatcher | Экземпляр диспетчера событий. | |
| static protected array | $booted | Массив запущенных моделей. | |
| static protected array | $globalScopes | Массив глобальных областей модели. | |
| static protected bool | $unguarded | Указывает, разрешено ли все массовое присваивание. | |
| static protected array | $mutatorCache | Кэширование измененных атрибутов для каждого класса. | |
| static array | $manyMethods | Методы отношений "многие ко многим". |
Методы
| void | __construct(array $attributes = []) Создать новый экземпляр модели Eloquent. | |
| void | bootIfNotBooted() Проверить, нужно ли загрузить модель, и если да, то сделать это. | |
| static void | boot() Метод "загрузки" модели. | |
| static void | bootTraits() Загрузить все загружаемые черты модели. | |
| static void | clearBootedModels() Очистить список загруженных моделей, чтобы они были перезагружены. | |
| 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() Получить глобальные scope для этого экземпляра класса. | |
| static void | observe(object|string $class, int $priority) Зарегистрировать observer в модели. | |
| $this | fill(array $attributes) Заполнить модель массивом атрибутов. | |
| $this | forceFill(array $attributes) Заполнить модель массивом атрибутов. Принудительное массовое присваивание. | |
| array | fillableFromArray(array $attributes) Получить заполняемые атрибуты заданного массива. | |
| Model | newInstance(array $attributes = [], bool $exists = false) Создать новый экземпляр данной модели. | |
| Model | newFromBuilder(array $attributes = [], string|null $connection = null) Создать новый экземпляр модели, который уже существует. | |
| static Collection | hydrate(array $items, string|null $connection = null) Создать коллекцию моделей из простых массивов. | |
| static Collection | hydrateRaw(string $query, array $bindings = [], string|null $connection = null) Создать коллекцию моделей из необработанного запроса. | |
| static Model | create(array $attributes = []) Сохранить новую модель и вернуть экземпляр. | |
| static Model | forceCreate(array $attributes) Сохранить новую модель и вернуть экземпляр. Разрешить массовое присваивание. | |
| static Builder | query() Начать запрос модели. | |
| static Builder | on(string|null $connection = null) Начать запрос модели на заданном соединении. | |
| static Builder | onWriteConnection() Начать запрос модели на соединении для записи. | |
| static Collection|Model[] | all(array|mixed $columns = ['*']) Получить все модели из базы данных. | |
| $this|null | fresh(array|string $with = []) Перезагрузить свежий экземпляр модели из базы данных. | |
| $this | load(array|string $relations) Жадная загрузка отношений в модели. | |
| static Builder|Model | with(array|string $relations) Начать запрос модели с жадной загрузкой. | |
| $this | append(array|string $attributes) Добавить атрибуты к запросу при построении запроса. | |
| 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 $otherKey = null, string $relation = null) Определить обратное отношение один-к-одному или многие-к-одному. | |
| MorphTo | morphTo(string $name = null, string $type = null, string $id = null) Определить полиморфное, обратное отношение один-к-одному или многие-к-одному. | |
| string | getActualClassNameForMorph(string $class) Получить полное имя класса из слагаемого. | |
| 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) Определить отношение многие-через-многие. | |
| 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 $otherKey = null, string $relation = null) Определить отношение многие-ко-многим. | |
| MorphToMany | morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false) Определить полиморфное отношение многие-ко-многим. |
| MorphToMany | morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null) Определить полиморфное, обратное многие-ко-многим отношение. | |
| строка | getBelongsToManyCaller() Получить имя отношения принадлежности ко многим. | |
| строка | joiningTable(string $related) Получить имя таблицы соединения для отношения многие-ко-многим. | |
| статический int | destroy(array|int $ids) Удалить модели для заданных идентификаторов. | |
| bool|null | delete() Удалить модель из базы данных. | |
| bool|null | forceDelete() Выполнить жесткое удаление мягко удалённой модели. | |
| void | performDeleteOnModel() Выполнить фактический запрос удаления для этой модели. | |
| статический void | saving(Closure|string $callback, int $priority) Зарегистрировать событие сохранения модели с диспетчером. | |
| статический void | saved(Closure|string $callback, int $priority) Зарегистрировать событие сохранения модели с диспетчером. | |
| статический void | updating(Closure|string $callback, int $priority) Зарегистрировать событие обновления модели с диспетчером. | |
| статический void | updated(Closure|string $callback, int $priority) Зарегистрировать событие обновления модели с диспетчером. | |
| статический void | creating(Closure|string $callback, int $priority) Зарегистрировать событие создания модели с диспетчером. | |
| статический void | created(Closure|string $callback, int $priority) Зарегистрировать событие создания модели с диспетчером. | |
| статический void | deleting(Closure|string $callback, int $priority) Зарегистрировать событие удаления модели с диспетчером. | |
| статический void | deleted(Closure|string $callback, int $priority) Зарегистрировать событие удаления модели с диспетчером. | |
| статический void | flushEventListeners() Удалить все слушатели событий для модели. | |
| статический void | registerModelEvent(string $event, Closure|string $callback, int $priority) Зарегистрировать событие модели с диспетчером. | |
| массив | getObservableEvents() Получить имена наблюдаемых событий. | |
| $this | setObservableEvents(array $observables) Установить имена наблюдаемых событий. | |
| void | addObservableEvents(array|mixed $observables) Добавить имя наблюдаемого события. | |
| void | removeObservableEvents(array|mixed $observables) Удалить имя наблюдаемого события. | |
| 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, string $method) Увеличить или уменьшить значение базового атрибута и синхронизировать с оригиналом. | |
| bool|int | update(array $attributes = [], array $options = []) Обновить модель в базе данных. | |
| bool | push() Сохранить модель и все её отношения. | |
| bool | save(array $options = []) Сохранить модель в базе данных. | |
| bool | saveOrFail(array $options = []) Сохранить модель в базе данных с использованием транзакции. | |
| void | finishSave(array $options) Завершить обработку успешной операции сохранения. | |
| bool | performUpdate(Builder $query, array $options = []) Выполнить операцию обновления модели. | |
| bool | performInsert(Builder $query, array $options = []) Выполнить операцию вставки модели. | |
| void | insertAndSetId(Builder $query, array $attributes) Вставить заданные атрибуты и установить идентификатор в модели. | |
| void | touchOwners() Обновить связанные отношения владельца модели. | |
| bool | touches(string $relation) Определить, касается ли модель данного отношения. | |
| mixed | fireModelEvent(string $event, bool $halt = true) Сгенерировать заданное событие для модели. | |
| Builder | setKeysForSaveQuery(Builder $query) Установить ключи для запроса сохранения обновления. | |
| mixed | getKeyForSaveQuery() Получить значение первичного ключа для запроса сохранения. | |
| bool | touch() Обновить метку последнего изменения модели. | |
| void | updateTimestamps() Обновить метки создания и изменения. | |
| $this | setCreatedAt(mixed $value) Установить значение атрибута "created at". | |
| $this | setUpdatedAt(mixed $value) Установить значение атрибута "updated at". | |
| строка | getCreatedAtColumn() Получить имя столбца "created at". | |
| строка | getUpdatedAtColumn() Получить имя столбца "updated at". |
| Carbon | freshTimestamp() Получить свежую метку времени для модели. | |
| string | freshTimestampString() Получить свежую метку времени для модели. | |
| Builder | newQuery() Получить новый билдер запросов для таблицы модели. | |
| Builder | newQueryWithoutScope(Scope|string $scope) Получить новый экземпляр запроса без заданного скоупа. | |
| Builder| Model | newQueryWithoutScopes() Получить новый билдер запросов без глобальных скоупов. | |
| Builder| Model | newEloquentBuilder( Builder $query) Создать новый билдер запросов Eloquent для модели. | |
| Builder | newBaseQueryBuilder() Получить новый экземпляр билдера запросов для соединения. | |
| Collection | newCollection(array $models = []) Создать новый экземпляр коллекции Eloquent. | |
| Pivot | newPivot( Model $parent, array $attributes, string $table, bool $exists) Создать новый экземпляр модели pivot. | |
| string | getTable() Получить таблицу, связанную с моделью. | |
| $this | setTable(string $table) Установить таблицу, связанную с моделью. | |
| mixed | getKey() Получить значение первичного ключа модели. | |
| mixed | getQueueableId() Получить идентификатор для планируемого выполнения. | |
| string | getKeyName() Получить первичный ключ для модели. | |
| $this | setKeyName(string $key) Установить первичный ключ для модели. | |
| string | getQualifiedKeyName() Получить имя квалифицированного первичного ключа. | |
| mixed | getRouteKey() Получить значение ключа маршрута модели. | |
| string | getRouteKeyName() Получить ключ маршрута для модели. | |
| bool | usesTimestamps() Определить, использует ли модель метки времени. | |
| array | getMorphs(string $name, string $type, string $id) Получить колонки полиморфного отношения. | |
| string | getMorphClass() Получить имя класса для полиморфных отношений. | |
| int | getPerPage() Получить количество моделей на страницу. | |
| $this | setPerPage(int $perPage) Установить количество моделей на страницу. | |
| string | getForeignKey() Получить имя внешнего ключа по умолчанию для модели. | |
| array | getHidden() Получить скрытые атрибуты для модели. | |
| $this | setHidden(array $hidden) Установить скрытые атрибуты для модели. | |
| void | addHidden(array|string|null $attributes = null) Добавить скрытые атрибуты для модели. | |
| $this | makeVisible(array|string $attributes) Сделать заданные атрибуты видимыми. | |
| $this | makeHidden(array|string $attributes) Сделать заданные атрибуты скрытыми. | |
| $this | withHidden(array|string $attributes) deprecated Сделать заданные атрибуты видимыми. | |
| array | getVisible() Получить видимые атрибуты для модели. | |
| $this | setVisible(array $visible) Установить видимые атрибуты для модели. | |
| void | addVisible(array|string|null $attributes = null) Добавить видимые атрибуты для модели. | |
| $this | setAppends(array $appends) Установить аксессоры для добавления к массивам модели. | |
| 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() Определить, является ли модель полностью защищенной. | |
| string | removeTableFromKey(string $key) Удалить имя таблицы из заданного ключа. | |
| array | getTouchedRelations() Получить отношения, которые затрагиваются при сохранении. |
| $this | setTouchedRelations(array $touches) Установить отношения, которые изменяются при сохранении. | |
| bool | getIncrementing() Получить значение, указывающее, являются ли идентификаторы нарастающими. | |
| $this | setIncrementing(bool $value) Установить, являются ли идентификаторы нарастающими. | |
| string | toJson(int $options) Преобразовать экземпляр модели в JSON. | |
| array | jsonSerialize() Преобразовать объект в сериализуемый в JSON. | |
| array | toArray() Преобразовать экземпляр модели в массив. | |
| array | attributesToArray() Преобразовать атрибуты модели в массив. | |
| array | getArrayableAttributes() Получить массив атрибутов, которые можно преобразовать в массив. | |
| array | getArrayableAppends() Получить все значения, подлежащие добавлению, которые можно преобразовать в массив. | |
| array | relationsToArray() Получить отношения модели в формате массива. | |
| array | getArrayableRelations() Получить массив атрибутов всех отношений, которые можно преобразовать в массив. | |
| array | getArrayableItems(array $values) Получить массив атрибутов всех значений, которые можно преобразовать в массив. | |
| mixed | getAttribute(string $key) Получить атрибут из модели. | |
| mixed | getAttributeValue(string $key) Получить простой атрибут (не отношение). | |
| mixed | getRelationValue(string $key) Получить отношение. | |
| mixed | getAttributeFromArray(string $key) Получить атрибут из массива $attributes. | |
| mixed | getRelationshipFromMethod(string $method) Получить значение отношения из метода. | |
| bool | hasGetMutator(string $key) Определить, существует ли мутатор get для атрибута. | |
| mixed | mutateAttribute(string $key, mixed $value) Получить значение атрибута с использованием его мутатора. | |
| mixed | mutateAttributeForArray(string $key, mixed $value) Получить значение атрибута с использованием его мутатора для преобразования в массив. | |
| bool | hasCast(string $key, array|string|null $types = null) Определить, должен ли атрибут быть преобразован к собственному типу. | |
| array | getCasts() Получить массив преобразуемых типов. | |
| bool | isDateCastable(string $key) Определить, можно ли преобразовать значение в дату / DateTime для входных данных. | |
| bool | isJsonCastable(string $key) Определить, можно ли преобразовать значение в JSON для входных данных. | |
| string | getCastType(string $key) Получить тип преобразования для атрибута модели. | |
| mixed | castAttribute(string $key, mixed $value) Преобразовать атрибут к собственному типу PHP. | |
| $this | setAttribute(string $key, mixed $value) Установить заданный атрибут в модели. | |
| bool | hasSetMutator(string $key) Определить, существует ли мутатор set для атрибута. | |
| array | getDates() Получить атрибуты, которые должны быть преобразованы в даты. | |
| string | fromDateTime(DateTime|int $value) Преобразовать DateTime в хранимую строку. | |
| Carbon | asDateTime(mixed $value) Возвращает отметку времени как объект DateTime. | |
| int | asTimeStamp(mixed $value) Возвращает отметку времени как метку времени Unix. | |
| string | serializeDate(DateTime $date) Подготовить дату для сериализации в массив / JSON. | |
| string | getDateFormat() Получить формат дат, хранимых в базе данных. | |
| $this | setDateFormat(string $format) Установить формат даты, используемый моделью. | |
| string | asJson(mixed $value) Кодировать заданное значение в JSON. | |
| mixed | fromJson(string $value, bool $asObject = false) Декодировать заданный JSON обратно в массив или объект. | |
| Модель | replicate(array $except = null) Клонировать модель в новый, не существующий экземпляр. | |
| 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) Определить, была ли изменена модель или заданные атрибуты. | |
| array | getDirty() Получить атрибуты, которые были изменены с момента последней синхронизации. | |
| bool | originalIsNumericallyEquivalent(string $key) Определить, являются ли новые и старые значения для заданного ключа численно эквивалентными. | |
| array | getRelations() Получить все загруженные отношения для экземпляра. | |
| mixed | getRelation(string $relation) Получить указанное отношение. |
| bool | relationLoaded(string $key) Определить, загружено ли данное отношение. | |
| $this | setRelation(string $relation, mixed $value) Установить конкретное отношение в модели. | |
| $this | setRelations(array $relations) Установить весь массив отношений в модели. | |
| Подключение | getConnection() Получить базу данных подключения для модели. | |
| string | getConnectionName() Получить текущее имя подключения для модели. | |
| $this | setConnection(string $name) Установить подключение, связанное с моделью. | |
| static Подключение | resolveConnection(string|null $connection = null) Разрешить экземпляр подключения. | |
| static Интерфейс разрешения подключения | getConnectionResolver() Получить экземпляр разрешения подключения. | |
| static void | setConnectionResolver(Интерфейс разрешения подключения $resolver) Установить экземпляр разрешения подключения. | |
| static void | unsetConnectionResolver() Удалить разрешение подключения для моделей. | |
| static Диспечер событий | getEventDispatcher() Получить экземпляр диспечера событий. | |
| static void | setEventDispatcher(Диспечер событий $dispatcher) Установить экземпляр диспечера событий. | |
| static void | unsetEventDispatcher() Удалить диспечер событий для моделей. | |
| array | getMutatedAttributes() Получить измененные атрибуты для данного экземпляра. | |
| static void | cacheMutatedAttributes(string $class) Извлечь и кэшировать все измененные атрибуты класса. | |
| 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() При десериализации модели, проверить, нужно ли ее инициализировать. |
Подробности
void __construct(array $attributes = [])
Создать новый экземпляр модели Eloquent.
protected void bootIfNotBooted()
Проверить, нужно ли инициализировать модель и сделать это, если нужно.
static protected void boot()
Метод "инициализации" модели.
static protected void bootTraits()
Инициализировать все инициализируемые трейты модели.
static void clearBootedModels()
Очистить список инициализированных моделей, чтобы они были повторно инициализированы.
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 модели.
массив getGlobalScopes()
Получить глобальные области видимости для данного экземпляра класса.
статический void observe(object|string $class, int $priority)
Зарегистрировать наблюдателя в модели.
$this fill(array $attributes)
Заполнить модель массивом атрибутов.
$this forceFill(array $attributes)
Заполнить модель массивом атрибутов. Принудительное применение массового назначения.
защищенный массив fillableFromArray(array $attributes)
Получить атрибуты, подлежащие заполнению, из заданного массива.
Модель newInstance(array $attributes = [], bool $exists = false)
Создать новый экземпляр заданной модели.
Модель newFromBuilder(array $attributes = [], string|null $connection = null)
Создать новый экземпляр модели, которая уже существует.
статический Коллекция hydrate(array $items, string|null $connection = null)
Создать коллекцию моделей из обычных массивов.
статический Коллекция hydrateRaw(string $query, array $bindings = [], string|null $connection = null)
Создать коллекцию моделей из запроса в сыром виде.
статический Модель create(array $attributes = [])
Сохранить новую модель и вернуть экземпляр.
статический Модель forceCreate(array $attributes)
Сохранить новую модель и вернуть экземпляр. Разрешить массовое назначение.
статический Билдер query()
Начать запросы к модели.
статический Билдер on(string|null $connection = null)
Начать запросы к модели на заданном соединении.
статический Билдер onWriteConnection()
Начать запросы к модели на подключении записи.
статический Коллекция|Модель[] all(array|mixed $columns = ['*'])
Получить все модели из базы данных.
$this|null fresh(array|string $with = [])
Перезагрузить свежий экземпляр модели из базы данных.
$this load(array|string $relations)
Загрузить отношения модели с помощью ленивой загрузки.
статический Билдер|Модель with(array|string $relations)
Начать запросы к модели с ленивой загрузкой.
$this append(array|string $attributes)
Добавить атрибуты к запросу при построении запроса.
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 $otherKey = null, string $relation = null)
Определение обратной связи один-к-одному или один-ко-многим.
MorphTo morphTo(string $name = null, string $type = null, string $id = null)
Определение полиморфной обратной связи один-к-одному или один-ко-многим.
string getActualClassNameForMorph(string $class)
Получение полному имени класса из сокращенного.
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 $otherKey = null, string $relation = null)
Определение связи многие-ко-многим.
MorphToMany morphToMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null, bool $inverse = false)
Определение полиморфной связи многие-ко-многим.
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)
Определение полиморфной, обратной связи многие-ко-многим.
protected string getBelongsToManyCaller()
Получение имени связи belongs to many.
string joiningTable(string $related)
Получение имени таблицы соединения для связи многие-ко-многим.
static int destroy(array|int $ids)
Удаление моделей по заданным идентификаторам.
bool|null delete()
Удаление модели из базы данных.
bool|null forceDelete()
Принудительно удалить мягко удалённую модель.
Этот метод защищает разработчиков от запуска forceDelete, когда признак отсутствует.
protected void performDeleteOnModel()
Выполнить фактическое удаление запроса для этой модели.
static void saving(Closure|string $callback, int $priority)
Регистрировать событие сохранения модели с диспетчером.
static void saved(Closure|string $callback, int $priority)
Регистрировать событие сохранения модели с диспетчером.
static void updating(Closure|string $callback, int $priority)
Регистрировать событие обновления модели с диспетчером.
static void updated(Closure|string $callback, int $priority)
Регистрировать событие обновлённой модели с диспетчером.
static void creating(Closure|string $callback, int $priority)
Регистрировать событие создания модели с диспетчером.
static void created(Closure|string $callback, int $priority)
Регистрировать событие созданной модели с диспетчером.
static void deleting(Closure|string $callback, int $priority)
Регистрировать событие удаления модели с диспетчером.
static void deleted(Closure|string $callback, int $priority)
Регистрировать событие удалённой модели с диспетчером.
static void flushEventListeners()
Удалить все обработчики событий для модели.
static protected void registerModelEvent(string $event, Closure|string $callback, int $priority)
Регистрировать событие модели с диспетчером.
array getObservableEvents()
Получить имена событий, которые можно наблюдать.
$this setObservableEvents(array $observables)
Установить имена событий, которые можно наблюдать.
void addObservableEvents(array|mixed $observables)
Добавить имя события, которое можно наблюдать.
void removeObservableEvents(array|mixed $observables)
Удалить имя события, которое можно наблюдать.
protected int increment(string $column, int $amount = 1, array $extra = [])
Увеличить значение столбца на заданное количество.
protected int decrement(string $column, int $amount = 1, array $extra = [])
Уменьшить значение столбца на заданное количество.
protected int incrementOrDecrement(string $column, int $amount, array $extra, string $method)
Выполнить метод увеличения или уменьшения для модели.
protected void incrementOrDecrementAttributeValue(string $column, int $amount, string $method)
Увеличить значение базового атрибута и синхронизировать его с исходным.
bool|int update(array $attributes = [], array $options = [])
Обновить модель в базе данных.
bool push()
Сохранить модель и все её отношения.
bool save(array $options = [])
Сохранить модель в базе данных.
bool saveOrFail(array $options = [])
Сохранить модель в базе данных с использованием транзакции.
protected void finishSave(array $options)
Завершить обработку при успешном сохранении.
protected bool performUpdate(Builder $query, array $options = [])
Выполнить операцию обновления модели.
protected bool performInsert(Builder $query, array $options = [])
Выполнить операцию вставки модели.
protected void insertAndSetId(Builder $query, array $attributes)
Вставить заданные атрибуты и установить ID модели.
void touchOwners()
Обновить время последнего изменения для зависимых отношений.
bool touches(string $relation)
Определить, затрагивает ли модель заданное отношение.
protected mixed fireModelEvent(string $event, bool $halt = true)
Вызвать заданное событие для модели.
protected mixed getKeyForSaveQuery()
Получить значение первичного ключа для запроса сохранения.
bool touch()
Обновить отметку времени последнего изменения модели.
protected void updateTimestamps()
Обновить отметки времени создания и последнего изменения.
$this setCreatedAt(mixed $value)
Установить значение атрибута "created at".
$this setUpdatedAt(mixed $value)
Установить значение атрибута "updated at".
string getCreatedAtColumn()
Получить имя столбца "created at".
string getUpdatedAtColumn()
Получить имя столбца "updated at".
Carbon freshTimestamp()
Получить свежую отметку времени для модели.
string freshTimestampString()
Получить свежую отметку времени для модели.
Builder newQuery()
Получить новый билдер запросов для таблицы модели.
Builder newQueryWithoutScope(Scope|string $scope)
Получить новый экземпляр запроса без заданного ограничения.
Builder|Model newQueryWithoutScopes()
Получить новый билдер запросов, который не имеет глобальных ограничений.
protected Builder newBaseQueryBuilder()
Получить новый экземпляр билдера запросов для подключения.
Collection newCollection(array $models = [])
Создать новый экземпляр коллекции Eloquent.
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists)
Создать новый экземпляр модели-связи.
string getTable()
Получить таблицу, связанную с моделью.
$this setTable(string $table)
Установить таблицу, связанную с моделью.
mixed getKey()
Получить значение первичного ключа модели.
mixed getQueueableId()
Получить идентификатор для очереди.
string getKeyName()
Получить первичный ключ модели.
$this setKeyName(string $key)
Установить первичный ключ модели.
string getQualifiedKeyName()
Получить имя квалифицированного ключа таблицы.
mixed getRouteKey()
Получить значение ключа маршрута модели.
string getRouteKeyName()
Получить ключ маршрута для модели.
bool usesTimestamps()
Определить, использует ли модель метки времени.
protected array getMorphs(string $name, string $type, string $id)
Получить столбцы полиморфных отношений.
string getMorphClass()
Получить имя класса для полиморфных отношений.
int getPerPage()
Получить количество моделей на страницу.
$this setPerPage(int $perPage)
Установить количество моделей на страницу.
string getForeignKey()
Получить имя внешнего ключа по умолчанию для модели.
array getHidden()
Получить скрытые атрибуты модели.
$this setHidden(array $hidden)
Установить скрытые атрибуты модели.
void addHidden(array|string|null $attributes = null)
Добавить скрытые атрибуты для модели.
$this makeVisible(array|string $attributes)
Сделать указанные, обычно скрытые, атрибуты видимыми.
$this makeHidden(array|string $attributes)
Сделать указанные, обычно видимые, атрибуты скрытыми.
$this withHidden(array|string $attributes) deprecated
deprecated
Сделать указанные, обычно скрытые, атрибуты видимыми.
array getVisible()
Получить видимые атрибуты для модели.
$this setVisible(array $visible)
Установить видимые атрибуты для модели.
void addVisible(array|string|null $attributes = null)
Добавить видимые атрибуты для модели.
$this setAppends(array $appends)
Установить аксессоры для добавления в массивы модели.
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)
Выполнить заданный вызываемый объект в режиме unguarded.
bool isFillable(string $key)
Определить, может ли указанный атрибут быть массово назначенным.
bool isGuarded(string $key)
Определить, является ли данный ключ защищенным.
bool totallyGuarded()
Определить, является ли модель полностью защищенной.
protected string removeTableFromKey(string $key)
Удалить имя таблицы из заданного ключа.
array getTouchedRelations()
Получить отношения, которые изменяются при сохранении.
$this setTouchedRelations(array $touches)
Установить отношения, которые изменяются при сохранении.
bool getIncrementing()
Получить значение, указывающее, являются ли идентификаторы нарастающими.
$this setIncrementing(bool $value)
Установить, являются ли идентификаторы нарастающими.
string toJson(int $options)
Преобразовать экземпляр модели в JSON.
массив jsonSerialize()
Преобразовать объект в формат, сериализуемый в JSON.
массив toArray()
Преобразовать экземпляр модели в массив.
массив attributesToArray()
Преобразовать атрибуты модели в массив.
защищённый массив getArrayableAttributes()
Получить массив всех атрибутов, пригодных для преобразования в массив.
защищённый массив getArrayableAppends()
Получить все значения, подлежащие добавлению, пригодные для преобразования в массив.
массив relationsToArray()
Получить связи модели в формате массива.
защищённый массив getArrayableRelations()
Получить массив всех связей, пригодных для преобразования в массив.
защищённый массив getArrayableItems(массив $values)
Получить массив всех значений, пригодных для преобразования в массив.
смешанный getAttribute(строка $key)
Получить атрибут модели.
смешанный getAttributeValue(строка $key)
Получить простой атрибут (не связь).
смешанный getRelationValue(строка $key)
Получить связь.
защищённый смешанный getAttributeFromArray(строка $key)
Получить атрибут из массива $attributes.
защищённый смешанный getRelationshipFromMethod(строка $method)
Получить значение связи из метода.
логическое hasGetMutator(строка $key)
Определить, существует ли мутатор get для атрибута.
защищённый смешанный mutateAttribute(строка $key, смешанный $value)
Получить значение атрибута с помощью его мутатора.
защищённый смешанный mutateAttributeForArray(строка $key, смешанный $value)
Получить значение атрибута с помощью его мутатора для преобразования в массив.
логическое hasCast(строка $key, массив|строка|null $types = null)
Определить, должен ли атрибут быть преобразован в родной тип.
массив getCasts()
Получить массив преобразуемых типов.
защищённый логическое isDateCastable(строка $key)
Определить, может ли значение быть преобразованно в дату/DateTime для обработки входящих данных.
защищённый логическое isJsonCastable(строка $key)
Определить, может ли значение быть преобразованно в JSON для обработки входящих данных.
защищённый строка getCastType(строка $key)
Получить тип преобразования для атрибута модели.
защищённый смешанный castAttribute(строка $key, смешанный $value)
Преобразовать атрибут в родной тип PHP.
$this setAttribute(строка $key, смешанный $value)
Установить заданный атрибут в модели.
логическое hasSetMutator(строка $key)
Определить, существует ли мутатор set для атрибута.
массив getDates()
Получить атрибуты, которые должны быть преобразованы в даты.
строка fromDateTime(DateTime|int $value)
Преобразовать DateTime в хранимую строку.
protected Carbon asDateTime(mixed $value)
Возвратить отметку времени как объект DateTime.
protected целое число asTimeStamp(mixed $value)
Возвратить отметку времени как временную метку Unix.
protected строка serializeDate(DateTime $date)
Подготовить дату для сериализации в массив/JSON.
protected строка getDateFormat()
Получить формат для дат, хранящихся в базе данных.
$this setDateFormat(строка $format)
Установить формат даты, используемый моделью.
protected строка asJson(смешанный $value)
Кодировать заданное значение как JSON.
смешанный fromJson(строка $value, bool $asObject = false)
Декодировать заданный JSON обратно в массив или объект.
Модель replicate(массив $except = null)
Клонировать модель в новую, не существующую сущность.
массив getAttributes()
Получить все текущие атрибуты модели.
$this setRawAttributes(массив $attributes, bool $sync = false)
Установить массив атрибутов модели. Проверка не выполняется.
смешанный|массив getOriginal(строка|null $key = null, смешанный $default = null)
Получить исходные значения атрибутов модели.
$this syncOriginal()
Синхронизировать исходные атрибуты с текущими.
$this syncOriginalAttribute(строка $attribute)
Синхронизировать отдельный исходный атрибут со своим текущим значением.
bool isDirty(массив|строка|null $attributes = null)
Определить, была ли изменена модель или заданные атрибуты.
массив getDirty()
Получить атрибуты, которые были изменены с момента последней синхронизации.
protected bool originalIsNumericallyEquivalent(строка $key)
Определить, являются ли новые и старые значения для данного ключа численно эквивалентными.
массив getRelations()
Получить все загруженные отношения для экземпляра.
смешанный getRelation(строка $relation)
Получить указанное отношение.
bool relationLoaded(строка $key)
Определить, загружено ли данное отношение.
$this setRelation(строка $relation, смешанный $value)
Установить указанное отношение в модели.
$this setRelations(массив $relations)
Установить весь массив отношений в модели.
Подключение getConnection()
Получить подключение к базе данных для модели.
строка getConnectionName()
Получить текущее имя подключения для модели.
$this setConnection(строка $name)
Установить подключение, связанное с моделью.
статический Подключение resolveConnection(строка|null $connection = null)
Разрешить экземпляр подключения.
статический Интерфейс разрешения подключений getConnectionResolver()
Получить экземпляр разрешителя подключений.
статический void setConnectionResolver(Интерфейс разрешения подключений $resolver)
Установить экземпляр разрешителя подключений.
статический void unsetConnectionResolver()
Удалить разрешитель подключений для моделей.
статический Диспечер событий getEventDispatcher()
Получить экземпляр диспечера событий.
статический void setEventDispatcher(Диспечер событий $dispatcher)
Установить экземпляр диспечера событий.
статический void unsetEventDispatcher()
Удалить диспечер событий для моделей.
массив getMutatedAttributes()
Получить изменённые атрибуты для данного экземпляра.
статический void cacheMutatedAttributes(строка $class)
Извлечь и кэшировать все изменённые атрибуты класса.
смешанный __get(строка $key)
Динамическое получение атрибутов модели.
void __set(строка $key, смешанный $value)
Динамическое установка атрибутов модели.
логическое offsetExists(смешанный $offset)
Определить, существует ли данный атрибут.
смешанный offsetGet(смешанный $offset)
Получить значение для заданного смещения.
void offsetSet(смешанный $offset, смешанный $value)
Установить значение для заданного смещения.
void offsetUnset(смешанный $offset)
Удалить значение для заданного смещения.
логическое __isset(строка $key)
Определить, существует ли атрибут или отношение в модели.
void __unset(строка $key)
Удалить атрибут в модели.
смешанный __call(строка $method, массив $parameters)
Обработка динамических вызовов методов в модели.
статический смешанный __callStatic(строка $method, массив $parameters)
Обработка динамических статических вызовов методов в методе.
string __toString()
Преобразовать модель в её строковое представление.
void __wakeup()
При десериализации модели проверить, нужно ли её загрузить.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Database/Eloquent/Model.html