Spec-Zone.ru › Laravel 5.4

Pivot

class Pivot extends Model (View source)

Трейты

HasAttributes
HasEvents
HasGlobalScopes
HasRelationships
HasTimestamps
HidesAttributes
GuardsAttributes

Константы

CREATED_AT

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

UPDATED_AT

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

Свойства

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

Методы

array attributesToArray()

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

from HasAttributes
array addDateAttributesToArray(array $attributes)

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

from HasAttributes
array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

from HasAttributes
array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

from HasAttributes
array getArrayableAttributes()

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

from HasAttributes
array getArrayableAppends()

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

from HasAttributes
array relationsToArray()

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

from HasAttributes
array getArrayableRelations()

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

from HasAttributes
array getArrayableItems(array $values)

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

from HasAttributes
mixed getAttribute(string $key)

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

from HasAttributes
mixed getAttributeValue(string $key)

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

from HasAttributes
mixed getAttributeFromArray(string $key)

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

from HasAttributes
mixed getRelationValue(string $key)

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

from HasAttributes
mixed getRelationshipFromMethod(string $method)

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

from HasAttributes
bool hasGetMutator(string $key)

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

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

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

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

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

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

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

from HasAttributes
string getCastType(string $key)

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

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

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

from HasAttributes
bool hasSetMutator(string $key)

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

from HasAttributes
bool isDateAttribute(string $key)

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

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

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

from HasAttributes
$this getArrayAttributeWithValue(string $path, string $key, mixed $value)

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

from HasAttributes
array getArrayAttributeByKey(string $key)

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

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

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

from HasAttributes
string asJson(mixed $value)

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

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

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

from HasAttributes
Carbon asDate(mixed $value)

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

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

Определить, можно ли преобразовать значение в Date / 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)

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

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

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

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

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

from HasRelationships
static string getActualClassNameForMorph(string $class)

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

from HasRelationships
string guessBelongsToRelation()

Угадать имя связи «belongs to».

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

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

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

Определить связь «имеет много через».

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

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

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

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

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

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

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

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

from HasRelationships
string guessBelongsToManyRelation()

Получить имя связи «belongs to many».

from HasRelationships
string joiningTable(string $related)

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

from HasRelationships
bool touches(string $relation)

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

from HasRelationships
void touchOwners()

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

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

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

from HasRelationships
string getMorphClass()

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

from HasRelationships
mixed newRelatedInstance(string $class)

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

from HasRelationships
array getRelations()

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

from HasRelationships
mixed getRelation(string $relation)

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

from HasRelationships
bool relationLoaded(string $key)

Определить, загружена ли заданная связь.

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

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

from HasRelationships
$this setRelations(array $relations)

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

from HasRelationships
array getTouchedRelations()

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

from HasRelationships
$this setTouchedRelations(array $touches)

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

from HasRelationships
bool touch()

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

from HasTimestamps
void updateTimestamps()

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

from HasTimestamps
$this setCreatedAt(mixed $value)

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

from HasTimestamps
$this setUpdatedAt(mixed $value)

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

from HasTimestamps
Carbon freshTimestamp()

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

from HasTimestamps
string freshTimestampString()

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

from HasTimestamps
bool usesTimestamps()

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

from HasTimestamps
string getCreatedAtColumn()

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

string getUpdatedAtColumn()

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

array getHidden()

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

from HidesAttributes
$this setHidden(array $hidden)

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

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

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

from HidesAttributes
array getVisible()

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

from HidesAttributes
$this setVisible(array $visible)

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

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

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

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

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

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

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

from HidesAttributes
array getFillable()

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

from GuardsAttributes
$this fillable(array $fillable)

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

from GuardsAttributes
array getGuarded()

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

from GuardsAttributes
$this guard(array $guarded)

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

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

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

from GuardsAttributes
static void reguard()

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

from GuardsAttributes
static bool isUnguarded()

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

from GuardsAttributes
static mixed unguarded(callable $callback)

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

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(Model $parent, array $attributes, string $table, bool $exists = false)

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

void bootIfNotBooted()

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

from Model
static void boot()

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

from Model
static void bootTraits()

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

from Model
static void clearBootedModels()

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

from Model
$this fill(array $attributes)

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

from Model
$this forceFill(array $attributes)

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

from Model
string removeTableFromKey(string $key)

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

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

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

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

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

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

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

from Model
static Builder onWriteConnection()

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

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

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

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

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

from Model
$this load(array|string $relations)

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

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

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

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

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

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

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

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

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

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

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

from Model
bool push()

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

from Model
bool save(array $options = [])

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

from Model
bool saveOrFail(array $options = [])

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

from Model
void finishSave(array $options)

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

from Model
bool performUpdate(Builder $query)

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

from Model
Builder setKeysForSaveQuery(Builder $query)

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

mixed getKeyForSaveQuery()

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

from Model
bool performInsert(Builder $query)

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

from Model
void insertAndSetId(Builder $query, array $attributes)

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

from Model
static int destroy(array|int $ids)

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

from Model
bool|null delete()

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

bool|null forceDelete()

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

from Model
void performDeleteOnModel()

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

from Model
static Builder query()

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

from Model
Builder newQuery()

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

from Model
Builder|Модель newQueryWithoutScopes()

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

из Модель
Builder newQueryWithoutScope(Scope|string $scope)

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

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

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

из Модель
Builder newBaseQueryBuilder()

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

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

Создать новую инстанцию коллекции Eloquent.

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

Создать новую инстанцию модели-связи.

из Модель
массив toArray()

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

из Модель
строка toJson(int $options)

Преобразовать инстанцию модели в JSON.

из Модель
массив jsonSerialize()

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

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

Перезагрузить инстанцию модели из базы данных.

из Модель
$this refresh()

Перезагрузить текущую инстанцию модели с актуальными атрибутами из базы данных.

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

Клонировать модель в новую, не существующую инстанцию.

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

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

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

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

из Модель
Соединение getConnection()

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

из Модель
строка getConnectionName()

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

из Модель
$this setConnection(string $name)

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

из Модель
статический Соединение resolveConnection(string|null $connection = null)

Разрешить инстанцию соединения.

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

Получить инстанцию разрешителя соединения.

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

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

из Модель
статический void unsetConnectionResolver()

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

из Модель
строка getTable()

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

из Модель
$this setTable(string $table)

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

из Модель
строка getKeyName()

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

из Модель
$this setKeyName(string $key)

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

из Модель
строка getQualifiedKeyName()

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

из Модель
строка getKeyType()

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

из Модель
$this setKeyType(string $type)

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

из Модель
bool getIncrementing()

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

из Модель
$this setIncrementing(bool $value)

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

из Модель
mixed getKey()

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

из Model
mixed getQueueableId()

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

из Model
mixed getRouteKey()

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

из Model
string getRouteKeyName()

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

из Model
string getForeignKey()

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

int getPerPage()

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

из Model
$this setPerPage(int $perPage)

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

из Model
mixed __get(string $key)

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

из Model
void __set(string $key, mixed $value)

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

из Model
bool offsetExists(mixed $offset)

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

из Model
mixed offsetGet(mixed $offset)

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

из Model
void offsetSet(mixed $offset, mixed $value)

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

из Model
void offsetUnset(mixed $offset)

Удалить значение для заданного смещения.

из Model
bool __isset(string $key)

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

из Model
void __unset(string $key)

Удалить атрибут модели.

из Model
mixed __call(string $method, array $parameters)

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

из Model
static mixed __callStatic(string $method, array $parameters)

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

из Model
string __toString()

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

из Model
void __wakeup()

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

из Model
static Pivot fromRawAttributes(Model $parent, array $attributes, string $table, bool $exists = false)

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

Builder getDeleteQuery()

Получить запрос для удаления pivot.

string getRelatedKey()

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

string getOtherKey()

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

$this setPivotKeys(string $foreignKey, string $relatedKey)

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

bool hasTimestampAttributes()

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

Подробное описание

array attributesToArray()

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

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

array

protected array addDateAttributesToArray(array $attributes)

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

Параметры

array $attributes

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

array

protected array addMutatedAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array addCastAttributesToArray(array $attributes, array $mutatedAttributes)

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

Параметры

array $attributes
array $mutatedAttributes

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

array

protected array getArrayableAttributes()

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

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

array

protected array getArrayableAppends()

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

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

array

array relationsToArray()

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

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

array

protected array getArrayableRelations()

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

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

array

protected array getArrayableItems(array $values)

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

Параметры

массив $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)

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

Параметры

string $key
mixed $value

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

$this

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

protected bool isDateAttribute(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

$this

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

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

Параметры

string $path
string $key
mixed $value

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

$this

protected array getArrayAttributeByKey(string $key)

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

Параметры

string $key

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

array

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

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

Параметры

string $key
mixed $value

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

string

protected string asJson(mixed $value)

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

Параметры

mixed $value

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

string

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

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

Параметры

string $value
bool $asObject

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

mixed

protected Carbon asDate(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected bool isStandardDateFormat(string $value)

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

Параметры

string $value

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

bool

string fromDateTime(DateTime|int $value)

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

Параметры

DateTime|int $value

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

string

protected int asTimestamp(mixed $value)

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

Параметры

mixed $value

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

int

protected string serializeDate(DateTimeInterface $date)

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

Параметры

DateTimeInterface $date

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

string

array getDates()

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

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

array

protected string getDateFormat()

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

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

string

$this setDateFormat(string $format)

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

Параметры

string $format

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

$this

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

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

Параметры

string $key
array|string|null $types

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

bool

array getCasts()

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

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

array

protected bool isDateCastable(string $key)

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

Параметры

string $key

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

bool

protected bool isJsonCastable(string $key)

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

Параметры

string $key

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

bool

array getAttributes()

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

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

array

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

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

Параметры

array $attributes
bool $sync

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

$this

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

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

Параметры

string|null $key
mixed $default

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

mixed|array

$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

array getDirty()

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

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

array

protected bool originalIsNumericallyEquivalent(string $key)

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

Параметры

string $key

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

bool

$this append(array|string $attributes)

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

Параметры

array|string $attributes

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

$this

$this setAppends(array $appends)

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

Параметры

array $appends

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

$this

массив getMutatedAttributes()

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

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

массив

статический void cacheMutatedAttributes(string $class)

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

Параметры

строка $class

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

void

статический защищённый массив getMutatorMethods(mixed $class)

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

Параметры

смешанный $class

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

массив

статический 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

статический защищённый void registerModelEvent(string $event, Closure|string $callback)

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

Параметры

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

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

void

защищённый смешанный fireModelEvent(string $event, bool $halt = true)

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

Параметры

строка $event
булево $halt

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

смешанный

защищённый смешанный|null fireCustomModelEvent(string $event, string $method)

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

Параметры

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

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

смешанный|null

защищённый смешанный filterModelEventResults(mixed $result)

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

Параметры

смешанный $result

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

смешанный

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

Параметры

Closure|строка $callback

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

void

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

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

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

void

static Dispatcher getEventDispatcher()

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

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

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Параметры

Dispatcher $dispatcher

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

void

static void unsetEventDispatcher()

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

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

void

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

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

Параметры

Scope|Closure|string $scope
Closure $implementation

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

mixed

Исключения

InvalidArgumentException

static bool hasGlobalScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

bool

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

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

Параметры

Scope|string $scope

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

Scope|Closure|null

array getGlobalScopes()

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

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

array

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

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

Параметры

string $related
string $foreignKey
string $localKey

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

HasOne

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

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

Параметры

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

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

MorphOne

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

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

Параметры

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

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

BelongsTo

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

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

Параметры

string $name
string $type
string $id

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

MorphTo

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

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

Параметры

string $name
string $type
string $id

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

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)

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

Параметры

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

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)

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

Параметры

array $guarded

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

$this

static void unguard(bool $state = true)

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

Параметры

bool $state

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

void

static void reguard()

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

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

void

static bool isUnguarded()

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

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

bool

static mixed unguarded(callable $callback)

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

Параметры

callable $callback

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

mixed

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

void __construct(Model $parent, array $attributes, string $table, bool $exists = false)

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

Параметры

Model $parent
array $attributes
string $table
bool $exists

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

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

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

void

static protected void bootTraits()

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

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

void

static void clearBootedModels()

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

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

void

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

$this forceFill(array $attributes)

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

Параметры

array $attributes

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

$this

protected string removeTableFromKey(string $key)

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

Параметры

string $key

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

string

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

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

Параметры

array $attributes
bool $exists

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

Model

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

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

Параметры

array $attributes
string|null $connection

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

Model

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

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

Параметры

string|null $connection

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

Builder

static Builder onWriteConnection()

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

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

Builder

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

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

Параметры

array|mixed $columns

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

Collection|Model[]

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

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

Параметры

array|string $relations

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

Builder|Model

$this load(array|string $relations)

Жадно загрузить отношения для модели.

Параметры

array|string $relations

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

$this

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

string $column
int $amount
array $extra

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

int

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

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

Параметры

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

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

int

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

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

Параметры

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

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

void

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

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

Параметры

array $attributes
array $options

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

bool

bool push()

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

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

bool

bool save(array $options = [])

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

Параметры

array $options

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

bool

bool saveOrFail(array $options = [])

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

Параметры

array $options

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

bool

Исключения

Throwable

protected void finishSave(array $options)

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

Параметры

array $options

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

void

protected bool performUpdate(Builder $query)

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

Параметры

Builder $query

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

bool

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

protected mixed getKeyForSaveQuery()

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

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

mixed

protected bool performInsert(Builder $query)

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

Параметры

Builder $query

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

bool

protected void insertAndSetId(Builder $query, array $attributes)

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

Параметры

Builder $query
array $attributes

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

void

static int destroy(array|int $ids)

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

bool|null forceDelete()

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

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

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

bool|null

protected void performDeleteOnModel()

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

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

void

static Builder query()

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

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

Builder

Builder newQuery()

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

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder newQueryWithoutScope(Scope|string $scope)

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

Параметры

Scope|string $scope

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

Builder

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

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

Параметры

Builder $query

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

Builder|Модель

protected Builder newBaseQueryBuilder()

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

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

Builder

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

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

Параметры

array $models

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

Коллекция

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

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

Параметры

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

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

Связь

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)

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

Параметры

Модель $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

static Pivot fromRawAttributes(Модель $parent, array $attributes, string $table, bool $exists = false)

Создать новую модель pivot из сырых значений, возвращённых запросом.

Параметры

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

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

Pivot

protected Builder getDeleteQuery()

Получить запрос для удаления pivot.

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

Builder

string getRelatedKey()

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

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

string

string getOtherKey()

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

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

string

$this setPivotKeys(string $foreignKey, string $relatedKey)

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

Параметры

string $foreignKey
string $relatedKey

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

$this

bool hasTimestampAttributes()

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

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

bool

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

Spec-Zone.ru

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