Spec-Zone.ru › Laravel 4.2

Pivot

class Pivot extends Model (View source)

Константы

CREATED_AT

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

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

Свойства

protected string $connection Имя подключения для модели. из Model
protected string $table Таблица, связанная с моделью. из Model
protected string $primaryKey Первичный ключ модели. из Model
protected int $perPage Количество моделей для возврата при пагинации. из Model
bool $incrementing Указывает, являются ли идентификаторы автоматически инкрементируемыми. из Model
bool $timestamps Указывает, нужно ли добавлять метки времени в модель. из Model
protected array $attributes Атрибуты модели. из Model
protected array $original Исходное состояние атрибутов модели. из Model
protected array $relations Загруженные отношения для модели. из Model
protected array $hidden Атрибуты, которые должны быть скрыты для массивов. из Model
protected array $visible Атрибуты, которые должны быть видимы в массивах. из Model
protected array $appends Методы доступа для добавления к представлению модели в виде массива. из Model
protected array $fillable Атрибуты, которые можно массово назначать. из Model
protected array $guarded Атрибуты, которые нельзя массово назначать.
protected array $dates Атрибуты, которые должны быть преобразованы в даты. из Model
protected array $touches Отношения, которые должны быть изменены при сохранении. из Model
protected array $observables Объектно-ориентированные события, доступные пользователю. из Model
protected array $with Отношения, которые нужно загружать жадно при каждом запросе. из Model
protected string $morphClass Имя класса, используемого в полиморфных отношениях. из Model
bool $exists Указывает, существует ли модель. из Model
static bool $snakeAttributes Указывает, преобразуются ли атрибуты в snake_case при работе с массивами. из Model
static protected ConnectionResolverInterface $resolver Экземпляр резолвера подключений. из Model
static protected Dispatcher $dispatcher Экземпляр диспетчера событий. из Model
static protected array $booted Массив запущенных моделей. из Model
static protected array $globalScopes Массив глобальных скопов модели. из Model
static protected bool $unguarded Указывает, разрешено ли все массовое назначение. из Model
static protected array $mutatorCache Кэш мутированных атрибутов для каждого класса. из Model
static array $manyMethods Методы отношений "многие ко многим". из Model
protected Model $parent Родительская модель отношения.
protected string $foreignKey Имя столбца внешнего ключа.
protected string $otherKey Имя столбца "другого ключа".

Методы

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 addGlobalScope(ScopeInterface $scope)

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

 from Model
static bool hasGlobalScope(ScopeInterface $scope)

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

 from Model
static ScopeInterface|null getGlobalScope(ScopeInterface $scope)

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

 from Model
ScopeInterface[] getGlobalScopes()

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

 from Model
static void observe(object $class)

Зарегистрировать observer в модели.

 from Model
$this fill(array $attributes)

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

 from Model
array fillableFromArray(array $attributes)

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

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

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

 from Model
Model newFromBuilder(array $attributes = array())

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

 from Model
static Collection hydrate(array $items, string $connection = null)

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

 from Model
static Collection hydrateRaw(string $query, array $bindings = array(), string $connection = null)

Создать коллекцию моделей из необработанного запроса.

 from Model
static Model create(array $attributes)

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

 from Model
static Model firstOrCreate(array $attributes)

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

 from Model
static Model firstOrNew(array $attributes)

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

 from Model
static Model updateOrCreate(array $attributes, array $values = array())

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

 from Model
static Model|null firstByAttributes(array $attributes)

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

 from Model
static Builder query()

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

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

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

 from Model
static Builder onWriteConnection()

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

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

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

 from Model
static Collection|Model|null find(mixed $id, array $columns = array('*'))

Найти модель по её первичному ключу.

 from Model
static Collection|Model findOrNew(mixed $id, array $columns = array('*'))

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

 from Model
static Collection|Model findOrFail(mixed $id, array $columns = array('*'))

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

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

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

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

Выполнение запроса к модели с ленивой загрузкой.

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

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

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

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

 from Model
BelongsTo belongsTo(string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

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

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

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

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

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

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

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

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

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

 from Model
BelongsToMany belongsToMany(string $related, string $table = null, string $foreignKey = null, string $otherKey = null, string $relation = null)

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

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

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

 from Model
MorphToMany morphedByMany(string $related, string $name, string $table = null, string $foreignKey = null, string $otherKey = null)

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

 from Model
string getBelongsToManyCaller()

Получение имени отношения «многие ко многим».

 from Model
string joiningTable(string $related)

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

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

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

 from Model
bool|null delete()

Удалить запись модели-моста из базы данных.
void forceDelete()

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

 from Model
void performDeleteOnModel()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 from Model
static void flushEventListeners()

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

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

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

 from Model
array getObservableEvents()

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

 from Model
void setObservableEvents(array $observables)

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

 from Model
void addObservableEvents(mixed $observables)

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

 from Model
void removeObservableEvents(mixed $observables)

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

 from Model
int increment(string $column, int $amount = 1)

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

 from Model
int decrement(string $column, int $amount = 1)

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

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

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

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

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

 from Model
bool|int update(array $attributes = array())

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

 from Model
bool push()

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

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

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

 from Model
void finishSave(array $options)

Завершить обработку после успешной операции сохранения.

 from Model
bool|null performUpdate(Builder $query, array $options = [])

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

 from Model
bool performInsert(Builder $query, array $options = [])

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

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

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

 from Model
void touchOwners()

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

 from Model
bool touches(string $relation)

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

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

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

 from Model
Builder setKeysForSaveQuery(Builder $query)

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

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

 from Model
bool touch()

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

 from Model
void updateTimestamps()

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

 from Model
void setCreatedAt(mixed $value)

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

 from Model
void setUpdatedAt(mixed $value)

Установить значение атрибута "дата обновления".

 from Model
string getCreatedAtColumn()

Получить имя столбца "дата создания".
string getUpdatedAtColumn()

Получить имя столбца "дата обновления".
Carbon freshTimestamp()

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

 from Model
string freshTimestampString()

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

 from Model
Builder newQuery()

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

 from Model
Builder newQueryWithoutScope(ScopeInterface $scope)

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

 from Model
Builder|Model newQueryWithoutScopes()

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

 from Model
Builder applyGlobalScopes(Builder $builder)

Применить все глобальные scope к построителю Eloquent.

 from Model
Builder removeGlobalScopes(Builder $builder)

Удалить все глобальные области видимости из Eloquent-билдера.

 from Model
Builder|Model newEloquentBuilder(Builder $query)

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

 from Model
Builder newBaseQueryBuilder()

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

 from Model
Collection newCollection(array $models = array())

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

 from Model
Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists)

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

 from Model
string getTable()

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

 from Model
void setTable(string $table)

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

 from Model
mixed getKey()

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

 from Model
string getKeyName()

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

 from Model
void setKeyName(string $key)

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

 from Model
string getQualifiedKeyName()

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

 from Model
bool usesTimestamps()

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

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

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

 from Model
string getMorphClass()

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

 from Model
int getPerPage()

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

 from Model
void setPerPage(int $perPage)

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

 from Model
string getForeignKey()

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

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

 from Model
void setHidden(array $hidden)

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

 from Model
void setVisible(array $visible)

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

 from Model
void setAppends(array $appends)

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

 from Model
array getFillable()

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

 from Model
$this fillable(array $fillable)

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

 from Model
array getGuarded()

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

 from Model
$this guard(array $guarded)

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

 from Model
static void unguard()

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

 from Model
static void reguard()

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

 from Model
static void setUnguardState(bool $state)

Установить "unguard" в заданное состояние.

 from Model
bool isFillable(string $key)

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

 from Model
bool isGuarded(string $key)

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

 from Model
bool totallyGuarded()

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

 from Model
string removeTableFromKey(string $key)

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

 from Model
array getTouchedRelations()

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

 from Model
void setTouchedRelations(array $touches)

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

 from Model
bool getIncrementing()

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

 from Model
void setIncrementing(bool $value)

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

 from Model
string toJson(int $options)

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

 from Model
array jsonSerialize()

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

 from Model
array toArray()

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

 from Model
array attributesToArray()

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

 from Model
array getArrayableAttributes()

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

 from Model
array getArrayableAppends()

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

 from Model
array relationsToArray()

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

 from Model
array getArrayableRelations()

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

 from Model
array getArrayableItems(array $values)

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

 from Model
mixed getAttribute(string $key)

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

 from Model
mixed getAttributeValue(string $key)

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

 from Model
mixed getAttributeFromArray(string $key)

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

 from Model
mixed getRelationshipFromMethod(string $key, string $camelKey)

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

 from Model
bool hasGetMutator(string $key)

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

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

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

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

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

 from Model
void setAttribute(string $key, mixed $value)

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

 from Model
bool hasSetMutator(string $key)

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

 from Model
array getDates()

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

 from Model
string fromDateTime(DateTime|int $value)

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

 from Model
Carbon asDateTime(mixed $value)

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

 from Model
string getDateFormat()

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

 from Model
Model replicate(array $except = null)

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

 from Model
array getAttributes()

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

 from Model
void setRawAttributes(array $attributes, bool $sync = false)

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

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

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

 from Model
$this syncOriginal()

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

 from Model
$this syncOriginalAttribute(string $attribute)

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

 from Model
bool isDirty(array|string|null $attributes = null)

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

 from Model
array getDirty()

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

 from Model
bool originalIsNumericallyEquivalent(string $key)

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

 from Модель
array getRelations()

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

 from Модель
mixed getRelation(string $relation)

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

 from Модель
$this setRelation(string $relation, mixed $value)

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

 from Модель
$this setRelations(array $relations)

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

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

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

 from Модель
string getConnectionName()

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

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

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

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

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

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

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

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

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

 from Модель
static void unsetConnectionResolver()

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

 from Модель
static Диспетчер событий getEventDispatcher()

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

 from Модель
static void setEventDispatcher(Диспетчер событий $dispatcher)

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

 from Модель
static void unsetEventDispatcher()

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

 from Модель
array getMutatedAttributes()

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

 from Модель
mixed __get(string $key)

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

 from Модель
void __set(string $key, mixed $value)

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

 from Модель
bool offsetExists(mixed $offset)

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

 from Модель
mixed offsetGet(mixed $offset)

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

 from Модель
void offsetSet(mixed $offset, mixed $value)

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

 from Модель
void offsetUnset(mixed $offset)

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

 from Модель
bool __isset(string $key)

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

 from Модель
void __unset(string $key)

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

 from Модель
mixed __call(string $method, array $parameters)

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

 from Модель
static mixed __callStatic(string $method, array $parameters)

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

 from Модель
string __toString()

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

 from Модель
void __wakeup()

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

 from Модель
Построитель getDeleteQuery()

Получить конструктор запроса для удаления по связующей таблице.
string getOtherKey()

Получить имя столбца "другого ключа".
$this setPivotKeys(string $foreignKey, string $otherKey)

Установить имена ключей для экземпляра модели связующей таблицы.
bool hasTimestampAttributes()

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

Подробности

void __construct(Модель $parent, array $attributes, string $table, bool $exists = false)

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

Параметры

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

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

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

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

void

static protected void bootTraits()

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

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

void

static void addGlobalScope(ИнтерфейсСкопа $scope)

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

Параметры

ИнтерфейсСкопа $scope

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

void

static bool hasGlobalScope(ИнтерфейсСкопа $scope)

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

Параметры

ИнтерфейсСкопа $scope

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

bool

static ИнтерфейсСкопа|null getGlobalScope(ИнтерфейсСкопа $scope)

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

Параметры

ИнтерфейсСкопа $scope

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

ИнтерфейсСкопа|null

ИнтерфейсСкопа[] getGlobalScopes()

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

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

ИнтерфейсСкопа[]

static void observe(object $class)

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

Параметры

object $class

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

void

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

ИсключениеМассовойЗамены

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

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

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

Параметры

array $attributes
bool $exists

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

Модель

Модель newFromBuilder(array $attributes = array())

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

Параметры

array $attributes

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

Модель

static Коллекция hydrate(array $items, string $connection = null)

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

Параметры

array $items
string $connection

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

Коллекция

static Коллекция hydrateRaw(string $query, array $bindings = array(), string $connection = null)

Создать коллекцию моделей из сырого запроса.

Параметры

string $query
array $bindings
string $connection

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

Коллекция

static Модель create(array $attributes)

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

Параметры

array $attributes

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

Модель

static Модель firstOrCreate(array $attributes)

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

Параметры

array $attributes

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

Модель

static Модель firstOrNew(array $attributes)

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

Параметры

array $attributes

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

Модель

static Модель updateOrCreate(array $attributes, array $values = array())

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

Параметры

array $attributes
array $values

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

Модель

static protected Модель|null firstByAttributes(array $attributes)

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

Параметры

array $attributes

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

Модель|null

static Библиотека query()

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

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

Библиотека

static Библиотека on(string $connection = null)

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

Параметры

string $connection

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

Библиотека

static Библиотека onWriteConnection()

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

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

Библиотека

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

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

Параметры

array $columns

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

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

static Коллекция|Модель|null find(mixed $id, array $columns = array('*'))

Найти модель по её первичному ключу.

Параметры

mixed $id
array $columns

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

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

static Коллекция|Модель findOrNew(mixed $id, array $columns = array('*'))

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

Параметры

mixed $id
array $columns

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

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

static Коллекция|Модель findOrFail(mixed $id, array $columns = array('*'))

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

Параметры

mixed $id
array $columns

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

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

Исключения

ИсключениеНеНайденоМодель

$this load(array|string $relations)

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

Параметры

array|string $relations

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

$this

static Библиотека|Модель with(array|string $relations)

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

Параметры

array|string $relations

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

Библиотека|Модель

ОдинКОдному hasOne(string $related, string $foreignKey = null, string $localKey = null)

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

Параметры

string $related
string $foreignKey
string $localKey

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

ОдинКОдному

ПолиморфныйОдинКОдному morphOne(string $related, string $name, string $type = null, string $id = null, string $localKey = null)

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

Параметры

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

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

ПолиморфныйОдинКОдному

СвязьС belongsTo(string $related, string $foreignKey = null, string $otherKey = null, string $relation = null)

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

Параметры

string $related
string $foreignKey
string $otherKey
string $relation

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

СвязьС

ПолиморфноеОбратное morphTo(string $name = null, string $type = null, string $id = null)

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

Параметры

string $name
string $type
string $id

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

ПолиморфноеОбратное

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 $related
string $through
string|null $firstKey
string|null $secondKey

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

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 $otherKey = null, string $relation = null)

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

Параметры

string $related
string $table
string $foreignKey
string $otherKey
string $relation

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

BelongsToMany

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

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

Параметры

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

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

MorphToMany

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

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

Параметры

string $related
string $name
string $table
string $foreignKey
string $otherKey

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

MorphToMany

protected string getBelongsToManyCaller()

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

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

string

string joiningTable(string $related)

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

Параметры

string $related

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

string

static int destroy(array|int $ids)

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

void forceDelete()

Выполнить удаление модели, даже если она была помечена на удаление.

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

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

void

protected void performDeleteOnModel()

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

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

void

static void saving(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void saved(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void updated(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void creating(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void created(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleting(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void deleted(Closure|string $callback)

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

Параметры

Closure|string $callback

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

void

static void flushEventListeners()

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

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

void

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

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

Параметры

string $event
Closure|string $callback

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

void

array getObservableEvents()

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

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

array

void setObservableEvents(array $observables)

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

Параметры

array $observables

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

void

void addObservableEvents(mixed $observables)

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

Параметры

mixed $observables

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

void

void removeObservableEvents(mixed $observables)

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

Параметры

mixed $observables

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

void

protected int increment(string $column, int $amount = 1)

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

Параметры

string $column
int $amount

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

int

protected int decrement(string $column, int $amount = 1)

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

Параметры

string $column
int $amount

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

int

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

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

Параметры

string $column
int $amount
string $method

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

int

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

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

Параметры

string $column
int $amount
string $method

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

void

bool|int update(array $attributes = array())

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

Параметры

array $attributes

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

bool|int

bool push()

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

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

bool

bool save(array $options = array())

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

Параметры

array $options

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

bool

protected void finishSave(array $options)

Завершить обработку успешной операции сохранения.

Параметры

array $options

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

void

protected bool|null performUpdate(Builder $query, array $options = [])

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

Параметры

Builder $query
array $options

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

bool|null

protected bool performInsert(Builder $query, array $options = [])

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

Параметры

Builder $query
array $options

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

bool

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

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

Параметры

Builder $query
array $attributes

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

void

void touchOwners()

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

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

void

bool touches(string $relation)

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

Параметры

string $relation

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

bool

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

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

Параметры

string $event
bool $halt

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

mixed

protected Builder setKeysForSaveQuery(Builder $query)

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

Параметры

Builder $query

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

Builder

protected mixed getKeyForSaveQuery()

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

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

mixed

bool touch()

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

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

bool

protected void updateTimestamps()

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

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

void

void setCreatedAt(mixed $value)

Установить значение атрибута «создано в».

Параметры

mixed $value

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

void

void setUpdatedAt(mixed $value)

Установить значение атрибута «обновлено в».

Параметры

mixed $value

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

void

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

Получить имя столбца «обновлено в».

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

string

Carbon freshTimestamp()

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

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

Carbon

string freshTimestampString()

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

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

string

Builder newQuery()

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

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

Builder

Builder newQueryWithoutScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

Builder

Builder|Model newQueryWithoutScopes()

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

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

Builder|Model

Builder applyGlobalScopes(Builder $builder)

Применить все глобальные ограничения к Eloquent-конструктору.

Параметры

Builder $builder

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

Builder

Builder removeGlobalScopes(Builder $builder)

Удалить все глобальные ограничения из Eloquent-конструктора.

Параметры

Builder $builder

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

Builder

Builder|Model newEloquentBuilder(Builder $query)

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

Параметры

Builder $query

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

Builder|Model

protected Builder newBaseQueryBuilder()

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

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

Builder

Collection newCollection(array $models = array())

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

Параметры

array $models

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

Collection

Pivot newPivot(Model $parent, array $attributes, string $table, bool $exists)

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

Параметры

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

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

Pivot

string getTable()

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

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

string

void setTable(string $table)

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

Параметры

string $table

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

void

mixed getKey()

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

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

mixed

string getKeyName()

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

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

string

void setKeyName(string $key)

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

Параметры

string $key

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

void

string getQualifiedKeyName()

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

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

string

bool usesTimestamps()

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

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

bool

protected array getMorphs(string $name, string $type, string $id)

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

Параметры

string $name
string $type
string $id

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

array

string getMorphClass()

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

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

string

int getPerPage()

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

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

int

void setPerPage(int $perPage)

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

Параметры

int $perPage

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

void

string getForeignKey()

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

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

string

array getHidden()

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

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

array

void setHidden(array $hidden)

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

Параметры

array $hidden

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

void

void setVisible(array $visible)

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

Параметры

array $visible

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

void

void setAppends(array $appends)

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

Параметры

array $appends

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

void

array getFillable()

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

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

array

$this fillable(array $fillable)

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

Параметры

array $fillable

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

$this

array getGuarded()

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

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

array

$this guard(array $guarded)

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

Параметры

array $guarded

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

$this

static void unguard()

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

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

void

static void reguard()

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

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

void

static void setUnguardState(bool $state)

Установить «unguard» в заданное состояние.

Параметры

bool $state

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

void

bool isFillable(string $key)

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

Параметры

string $key

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

bool

bool isGuarded(string $key)

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

Параметры

string $key

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

bool

bool totallyGuarded()

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

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

bool

protected string removeTableFromKey(string $key)

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

Параметры

string $key

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

string

array getTouchedRelations()

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

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

array

void setTouchedRelations(array $touches)

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

Параметры

array $touches

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

void

bool getIncrementing()

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

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

bool

void setIncrementing(bool $value)

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

Параметры

bool $value

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

void

string toJson(int $options)

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

Параметры

int $options

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

string

array jsonSerialize()

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

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

array

array toArray()

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

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

array

array attributesToArray()

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

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

array

protected array getArrayableAttributes()

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

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

array

protected array getArrayableAppends()

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

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

array

array relationsToArray()

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

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

array

protected array getArrayableRelations()

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

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

array

protected array getArrayableItems(array $values)

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

Параметры

array $values

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

array

mixed getAttribute(string $key)

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

Параметры

string $key

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

mixed

protected mixed getAttributeValue(string $key)

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

Параметры

string $key

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

mixed

protected mixed getAttributeFromArray(string $key)

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

Параметры

string $key

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

mixed

protected mixed getRelationshipFromMethod(string $key, string $camelKey)

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

Параметры

string $key
string $camelKey

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

mixed

Исключения

LogicException

bool hasGetMutator(string $key)

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

Параметры

string $key

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

bool

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

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

Параметры

string $key
mixed $value

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

mixed

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

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

Параметры

string $key
mixed $value

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

mixed

void setAttribute(string $key, mixed $value)

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

Параметры

string $key
mixed $value

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

void

bool hasSetMutator(string $key)

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

Параметры

string $key

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

bool

array getDates()

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

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

array

string fromDateTime(DateTime|int $value)

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

Параметры

DateTime|int $value

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

string

protected Carbon asDateTime(mixed $value)

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

Параметры

mixed $value

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

Carbon

protected string getDateFormat()

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

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

string

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

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

Параметры

array $except

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

Модель

array getAttributes()

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

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

array

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

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

Параметры

array $attributes
bool $sync

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

void

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

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

Параметры

string $key
mixed $default

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

array

$this syncOriginal()

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

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

$this

$this syncOriginalAttribute(string $attribute)

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

Параметры

string $attribute

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

$this

bool isDirty(array|string|null $attributes = null)

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

Параметры

array|string|null $attributes

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

bool

array getDirty()

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

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

array

protected bool originalIsNumericallyEquivalent(string $key)

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

Параметры

string $key

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

bool

array getRelations()

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

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

array

mixed getRelation(string $relation)

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

Параметры

string $relation

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

mixed

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

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

Параметры

string $relation
mixed $value

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

$this

$this setRelations(array $relations)

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

Параметры

array $relations

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

$this

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

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

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

Подключение

string getConnectionName()

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

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

string

$this setConnection(string $name)

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

Параметры

string $name

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

$this

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

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

Параметры

string $connection

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

Подключение

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

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

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

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

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

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

Параметры

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

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

void

static void unsetConnectionResolver()

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

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

void

static Dispatcher getEventDispatcher()

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

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

Dispatcher

static void setEventDispatcher(Dispatcher $dispatcher)

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

Параметры

Dispatcher $dispatcher

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

void

static void unsetEventDispatcher()

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

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

void

array getMutatedAttributes()

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

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

array

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

protected Builder getDeleteQuery()

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

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

Builder

string getOtherKey()

Получить имя столбца "другого ключа".

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

string

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

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

Параметры

string $foreignKey
string $otherKey

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

$this

bool hasTimestampAttributes()

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

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

bool

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

Spec-Zone.ru

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