Spec-Zone.ru › Laravel 4.2

MorphPivot

class MorphPivot extends Pivot (View source)

Константы

CREATED_AT

Имя столбца "created at".

UPDATED_AT

Имя столбца "updated at".

Свойства

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

Методы

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

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

from Pivot
void bootIfNotBooted()

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

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

Метод "инициализации" модели.

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

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

from Модель
static void addGlobalScope(ScopeInterface $scope)

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

from Модель
static bool hasGlobalScope(ScopeInterface $scope)

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

from Модель
static ScopeInterface|null getGlobalScope(ScopeInterface $scope)

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

from Модель
ScopeInterface[] getGlobalScopes()

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

from Модель
static void observe(object $class)

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

from Модель
$this fill(array $attributes)

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

from Модель
array fillableFromArray(array $attributes)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from Модель
static Билдер query()

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

from Модель
static Билдер on(string $connection = null)

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

from Модель
static Билдер onWriteConnection()

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

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

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

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

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

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

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

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

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

from Модель
$this load(array|string $relations)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Model
string getBelongsToManyCaller()

Получить имя связи «многие ко многим».

из Model
string joiningTable(string $related)

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

из Model
static int destroy(array|int $ids)

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

из Model
bool|null delete()

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

void forceDelete()

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

из Model
void performDeleteOnModel()

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

из Model
static void saving(Closure|string $callback)

Регистрация события сохранения модели с диспетчером.

из Model
static void saved(Closure|string $callback)

Регистрация события сохранения модели с диспетчером.

из Model
static void updating(Closure|string $callback)

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

из Model
static void updated(Closure|string $callback)

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

из Model
static void creating(Closure|string $callback)

Регистрация события создания модели с диспетчером.

из Model
static void created(Closure|string $callback)

Регистрация события создания модели с диспетчером.

из Model
static void deleting(Closure|string $callback)

Регистрация события удаления модели с диспетчером.

из Model
static void deleted(Closure|string $callback)

Регистрация события удаления модели с диспетчером.

из Model
static void flushEventListeners()

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

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

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

from Модель
array getObservableEvents()

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

from Модель
void setObservableEvents(array $observables)

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

from Модель
void addObservableEvents(mixed $observables)

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

from Модель
void removeObservableEvents(mixed $observables)

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

from Модель
int increment(string $column, int $amount = 1)

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

from Модель
int decrement(string $column, int $amount = 1)

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

from Модель
int incrementOrDecrement(string $column, int $amount, string $method)

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

from Модель
void incrementOrDecrementAttributeValue(string $column, int $amount, string $method)

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

from Модель
bool|int update(array $attributes = array())

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

from Модель
bool push()

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

from Модель
bool save(array $options = array())

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

from Модель
void finishSave(array $options)

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

from Модель
bool|null performUpdate(Builder $query, array $options = [])

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

from Модель
bool performInsert(Builder $query, array $options = [])

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

from Модель
void insertAndSetId(Builder $query, array $attributes)

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

from Модель
void touchOwners()

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

from Модель
bool touches(string $relation)

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

from Модель
mixed fireModelEvent(string $event, bool $halt = true)

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

from Модель
Builder setKeysForSaveQuery(Builder $query)

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

mixed getKeyForSaveQuery()

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

from Модель
bool touch()

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

from Модель
void updateTimestamps()

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

from Модель
void setCreatedAt(mixed $value)

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

from Модель
void setUpdatedAt(mixed $value)

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

from Модель
string getCreatedAtColumn()

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

from Связующая таблица
string getUpdatedAtColumn()

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

from Связующая таблица
Carbon freshTimestamp()

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

from Модель
string freshTimestampString()

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

from Модель
Builder newQuery()

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

from Модель
Builder newQueryWithoutScope(ScopeInterface $scope)

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

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

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

из Модели
Builder applyGlobalScopes(Builder $builder)

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

из Модели
Builder removeGlobalScopes(Builder $builder)

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

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

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

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

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

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

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

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

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

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

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

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

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

из Модели
смешанное getKey()

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

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

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

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

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

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

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

из Модели
bool usesTimestamps()

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

из Модели
массив getMorphs(string $name, string $type, string $id)

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

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

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

из Модели
целое getPerPage()

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

из Модели
void setPerPage(int $perPage)

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

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

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

из Связи
массив getHidden()

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

из Модели
void setHidden(array $hidden)

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

из Модели
void setVisible(array $visible)

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

из Модели
void setAppends(array $appends)

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

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

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

из Модели
$this fillable(array $fillable)

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

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

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

из Модели
$this guard(array $guarded)

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

из Модели
static void unguard()

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

из Модели
static void reguard()

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

из Модели
static void setUnguardState(bool $state)

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

из Модели
bool isFillable(string $key)

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

из Модели
bool isGuarded(string $key)

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

из Модели
bool totallyGuarded()

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

из Model
string removeTableFromKey(string $key)

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

из Model
array getTouchedRelations()

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

из Model
void setTouchedRelations(array $touches)

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

из Model
bool getIncrementing()

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

из Model
void setIncrementing(bool $value)

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

из Model
string toJson(int $options)

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

из Model
array jsonSerialize()

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

из Model
array toArray()

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

из Model
array attributesToArray()

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

из Model
array getArrayableAttributes()

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

из Model
array getArrayableAppends()

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

из Model
array relationsToArray()

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

из Model
array getArrayableRelations()

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

из Model
array getArrayableItems(array $values)

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

из Model
mixed getAttribute(string $key)

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

из Model
mixed getAttributeValue(string $key)

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

из Model
mixed getAttributeFromArray(string $key)

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

из Model
mixed getRelationshipFromMethod(string $key, string $camelKey)

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

из Model
bool hasGetMutator(string $key)

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

из Model
mixed mutateAttribute(string $key, mixed $value)

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

из Model
mixed mutateAttributeForArray(string $key, mixed $value)

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

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

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

из Model
bool hasSetMutator(string $key)

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

из Model
array getDates()

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

из Model
string fromDateTime(DateTime|int $value)

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

из Model
Carbon asDateTime(mixed $value)

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

из Model
string getDateFormat()

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

из Model
Model replicate(array $except = null)

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

из Model
array getAttributes()

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

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

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

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

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

из Model
$this syncOriginal()

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

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

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

from Model
mixed getRelation(string $relation)

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

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

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

from Model
$this setRelations(array $relations)

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

from Model
Connection getConnection()

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

from Model
string getConnectionName()

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

from Model
$this setConnection(string $name)

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

from Model
static Connection resolveConnection(string $connection = null)

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

from Model
static ConnectionResolverInterface getConnectionResolver()

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

from Model
static void setConnectionResolver(ConnectionResolverInterface $resolver)

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

from Model
static void unsetConnectionResolver()

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

from Model
static Dispatcher getEventDispatcher()

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

from Model
static void setEventDispatcher(Dispatcher $dispatcher)

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

from Model
static void unsetEventDispatcher()

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

from Model
array getMutatedAttributes()

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

from Model
mixed __get(string $key)

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

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

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

from Model
bool offsetExists(mixed $offset)

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

from Model
mixed offsetGet(mixed $offset)

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

from Model
void offsetSet(mixed $offset, mixed $value)

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

from Model
void offsetUnset(mixed $offset)

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

from Model
bool __isset(string $key)

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

from Model
void __unset(string $key)

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

from Model
mixed __call(string $method, array $parameters)

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

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

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

from Model
string __toString()

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

from Model
void __wakeup()

При десериализации модели проверить, требуется ли её запуск.

from Model
Builder getDeleteQuery()

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

из Pivot
строка getOtherKey()

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

из Pivot
$this setPivotKeys(строка $foreignKey, строка $otherKey)

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

из Pivot
логическое значение hasTimestampAttributes()

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

из Pivot
$this setMorphType(строка $morphType)

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

MorphPivot setMorphClass(строка $morphClass)

Установить класс морфинга для связующей таблицы.

Подробности

void __construct(Модель $parent, массив $attributes, строка $table, логическое значение $exists = false)

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

Параметры

Модель $parent
массив $attributes
строка $table
логическое значение $exists

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

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

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

void

static protected void bootTraits()

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

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

void

static void addGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

void

static bool hasGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

bool

static ScopeInterface|null getGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

ScopeInterface|null

ScopeInterface[] getGlobalScopes()

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

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

ScopeInterface[]

static void observe(object $class)

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

Параметры

object $class

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

void

$this fill(массив $attributes)

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

Параметры

массив $attributes

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

$this

Исключения

MassAssignmentException

protected массив fillableFromArray(массив $attributes)

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

Параметры

массив $attributes

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

массив

Модель newInstance(массив $attributes = массив(), логическое значение $exists = false)

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

Параметры

массив $attributes
логическое значение $exists

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

Модель

Модель newFromBuilder(массив $attributes = массив())

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

Параметры

массив $attributes

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

Модель

static Коллекция hydrate(массив $items, строка $connection = null)

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

Параметры

массив $items
строка $connection

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

Коллекция

static Коллекция hydrateRaw(строка $query, массив $bindings = массив(), строка $connection = null)

Создание коллекции моделей из исходного запроса.

Параметры

строка $query
массив $bindings
строка $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)

Загрузить отношения модели с использованием eager loading.

Параметры

array|string $relations

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

$this

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

Использование eager loading при запросе к модели.

Параметры

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

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

Параметры

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

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

BelongsTo

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

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

Параметры

string $name
string $type
string $id

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

MorphTo

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

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

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

string

string joiningTable(string $related)

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

Параметры

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)

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

Параметры

mixed $value

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

void

void setUpdatedAt(mixed $value)

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

Параметры

mixed $value

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

void

string getCreatedAtColumn()

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

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

string

string getUpdatedAtColumn()

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

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

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

Библиотека|Модель newEloquentBuilder(Библиотека $query)

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

Параметры

Библиотека $query

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

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

protected Библиотека newBaseQueryBuilder()

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

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

Библиотека

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

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

Параметры

array $models

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

Коллекция

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

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

Параметры

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

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

Связь

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

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

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

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

void

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

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

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

void

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

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

Parameters

string $key
mixed $value

Return Value

mixed

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

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

Parameters

string $key
mixed $value

Return Value

mixed

void setAttribute(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

void

bool hasSetMutator(string $key)

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

Parameters

string $key

Return Value

bool

array getDates()

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

Return Value

array

string fromDateTime(DateTime|int $value)

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

Parameters

DateTime|int $value

Return Value

string

protected Carbon asDateTime(mixed $value)

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

Parameters

mixed $value

Return Value

Carbon

protected string getDateFormat()

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

Return Value

string

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

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

Parameters

array $except

Return Value

Модель

array getAttributes()

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

Return Value

array

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

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

Parameters

array $attributes
bool $sync

Return Value

void

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

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

Parameters

string $key
mixed $default

Return Value

array

$this syncOriginal()

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

Return Value

$this

$this syncOriginalAttribute(string $attribute)

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

Parameters

string $attribute

Return Value

$this

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

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

Parameters

array|string|null $attributes

Return Value

bool

array getDirty()

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

Return Value

array

protected bool originalIsNumericallyEquivalent(string $key)

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

Parameters

string $key

Return Value

bool

array getRelations()

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

Return Value

array

mixed getRelation(string $relation)

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

Parameters

string $relation

Return Value

mixed

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

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

Parameters

string $relation
mixed $value

Return Value

$this

$this setRelations(array $relations)

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

Parameters

array $relations

Return Value

$this

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

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

Return Value

Подключение

string getConnectionName()

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

Return Value

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 Диспетчер событий getEventDispatcher()

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

Значение результата

Диспетчер событий

static void setEventDispatcher(Диспетчер событий $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 Построитель getDeleteQuery()

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

Значение результата

Построитель

string getOtherKey()

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

Значение результата

string
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $foreignKey
string $otherKey

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

$this

bool hasTimestampAttributes()

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

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

bool

$this setMorphType(string $morphType)

Установить тип морфизма для pivot.

Параметры

string $morphType

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

$this

MorphPivot setMorphClass(string $morphClass)

Установить класс морфизма для pivot.

Параметры

string $morphClass

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

MorphPivot

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

Spec-Zone.ru

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