Spec-Zone.ru › Laravel 4.2

Модель

класс Модель реализует ArrayAccess, ArrayableInterface, JsonableInterface, JsonSerializable (Просмотреть исходный код)

Константы

CREATED_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 Атрибуты, которые нельзя массово назначать.
protected array $dates Атрибуты, которые должны быть преобразованы в даты.
protected array $touches Отношения, которые должны быть затронуты при сохранении.
protected array $observables Представленные пользователю наблюдаемые события
protected array $with Отношения, которые должны быть загружены при каждом запросе.
protected string $morphClass Имя класса, используемого в полиморфных отношениях.
bool $exists Указывает, существует ли модель.
static bool $snakeAttributes Указывает, преобразуются ли атрибуты в snake_case в массивах.
static protected ConnectionResolverInterface $resolver Экземпляр решателя подключений.
static protected Dispatcher $dispatcher Экземпляр диспетчера событий.
static protected array $booted Массив запущенных моделей.
static protected array $globalScopes Массив глобальных областей видимости модели.
static protected bool $unguarded Указывает, разрешены ли все массовые назначения.
static protected array $mutatorCache Кэш мутированных атрибутов для каждого класса.
static array $manyMethods Методы для многих-ко-многим отношений.

Методы

void __construct(array $attributes = array())

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

void bootIfNotBooted()

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

static void boot()

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

static void bootTraits()

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

static void addGlobalScope(ScopeInterface $scope)

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

static bool hasGlobalScope(ScopeInterface $scope)

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

static ScopeInterface|null getGlobalScope(ScopeInterface $scope)

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

ScopeInterface[] getGlobalScopes()

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

static void observe(object $class)

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

$this fill(array $attributes)

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

array fillableFromArray(array $attributes)

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

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

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

Model newFromBuilder(array $attributes = array())

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

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

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

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

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

static Model create(array $attributes)

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

static Model firstOrCreate(array $attributes)

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

static Model firstOrNew(array $attributes)

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

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

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

static Model|null firstByAttributes(array $attributes)

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

static Builder query()

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

static Builder on(string $connection = null)

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

static Builder onWriteConnection()

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

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

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

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

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

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

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

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

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

$this load(array|string $relations)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Определить отношение имеет-через-много.

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

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

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

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

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

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

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

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

string getBelongsToManyCaller()

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

string joiningTable(string $related)

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

static int destroy(array|int $ids)

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

bool|null delete()

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

void forceDelete()

Выполнить удаление модели, проигнорировав мягкое удаление.

void performDeleteOnModel()

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

static void saving(Closure|string $callback)

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

static void saved(Closure|string $callback)

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

static void updating(Closure|string $callback)

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

static void updated(Closure|string $callback)

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

static void creating(Closure|string $callback)

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

static void created(Closure|string $callback)

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

static void deleting(Closure|string $callback)

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

static void deleted(Closure|string $callback)

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

static void flushEventListeners()

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

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

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

array getObservableEvents()

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

void setObservableEvents(array $observables)

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

void addObservableEvents(mixed $observables)

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

void removeObservableEvents(mixed $observables)

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

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

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

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

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

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

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

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

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

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

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

bool push()

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

bool save(array $options = array())

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

void finishSave(array $options)

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

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

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

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

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

void insertAndSetId(Builder $query, array $attributes)

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

void touchOwners()

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

bool touches(string $relation)

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

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

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

Builder setKeysForSaveQuery(Builder $query)

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

mixed getKeyForSaveQuery()

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

bool touch()

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

void updateTimestamps()

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

void setCreatedAt(mixed $value)

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

void setUpdatedAt(mixed $value)

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

строка getCreatedAtColumn()

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

строка getUpdatedAtColumn()

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

Carbon freshTimestamp()

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

строка freshTimestampString()

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

Builder newQuery()

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

Builder newQueryWithoutScope(ScopeInterface $scope)

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

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

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

строка removeTableFromKey(string $key)

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

массив getTouchedRelations()

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

void setTouchedRelations(array $touches)

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

bool getIncrementing()

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

void setIncrementing(bool $value)

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

строка toJson(int $options)

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

массив jsonSerialize()

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

массив toArray()

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

массив attributesToArray()

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

массив getArrayableAttributes()

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

массив getArrayableAppends()

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

массив relationsToArray()

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

массив getArrayableRelations()

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

массив getArrayableItems(array $values)

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

смешанный getAttribute(string $key)

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

смешанный getAttributeValue(string $key)

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

смешанный getAttributeFromArray(string $key)

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

смешанный getRelationshipFromMethod(string $key, string $camelKey)

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

булево hasGetMutator(string $key)

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

смешанный mutateAttribute(string $key, mixed $value)

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

смешанный mutateAttributeForArray(string $key, mixed $value)

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

пустое setAttribute(string $key, mixed $value)

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

булево hasSetMutator(string $key)

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

массив getDates()

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

строка fromDateTime(DateTime|int $value)

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

Carbon asDateTime(mixed $value)

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

строка getDateFormat()

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

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

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

массив getAttributes()

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

пустое setRawAttributes(array $attributes, bool $sync = false)

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

массив getOriginal(string $key = null, mixed $default = null)

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

$this syncOriginal()

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

$this syncOriginalAttribute(string $attribute)

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

булево isDirty(array|string|null $attributes = null)

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

массив getDirty()

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

булево originalIsNumericallyEquivalent(string $key)

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

массив getRelations()

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

смешанный getRelation(string $relation)

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

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

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

$this setRelations(array $relations)

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

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

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

строка getConnectionName()

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

$this setConnection(string $name)

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

статический Подключение resolveConnection(string $connection = null)

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

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

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

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

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

статический пустое unsetConnectionResolver()

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

статический Диспетчер событий getEventDispatcher()

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

статический пустое setEventDispatcher(Диспетчер событий $dispatcher)

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

статический пустое unsetEventDispatcher()

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

массив getMutatedAttributes()

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

смешанный __get(string $key)

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

пустое __set(string $key, mixed $value)

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

bool offsetExists(mixed $offset)

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

mixed offsetGet(mixed $offset)

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

void offsetSet(mixed $offset, mixed $value)

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

void offsetUnset(mixed $offset)

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

bool __isset(string $key)

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

void __unset(string $key)

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

mixed __call(string $method, array $parameters)

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

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

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

string __toString()

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

void __wakeup()

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

Подробности

void __construct(array $attributes = array())

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

Параметры

array $attributes

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

void

protected void bootIfNotBooted()

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

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

void

static protected void boot()

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

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

void

static protected void bootTraits()

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

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

void

static void addGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

void

static bool hasGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

bool

static ScopeInterface|null getGlobalScope(ScopeInterface $scope)

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

Параметры

ScopeInterface $scope

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

ScopeInterface|null

ScopeInterface[] getGlobalScopes()

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

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

ScopeInterface[]

static void observe(object $class)

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

Параметры

object $class

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

void

$this fill(array $attributes)

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

Параметры

array $attributes

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

$this

Исключения

MassAssignmentException

protected array fillableFromArray(array $attributes)

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

Параметры

array $attributes

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

array

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

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

Параметры

array $attributes
bool $exists

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

Model

Model newFromBuilder(array $attributes = array())

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

Параметры

array $attributes

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

Model

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

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

Параметры

array $items
string $connection

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

Collection

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

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

Параметры

string $query
array $bindings
string $connection

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

Collection
END_OF_DOCUMENT_MARKER

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 load) для модели.

Параметры

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

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

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

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)

Определить отношение has-many-through.

Параметры

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)

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

Параметры

string $related

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

string

static int destroy(array|int $ids)

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

Параметры

array|int $ids

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

int

bool|null delete()

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

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

bool|null

Исключения

Exception

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
END_OF_DOCUMENT_MARKER

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

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

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

Параметры

Builder $query

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

Builder|Модель

protected Builder newBaseQueryBuilder()

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

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

Builder

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

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

Параметры

array $models

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

Коллекция

Pivot newPivot(Модель $parent, array $attributes, string $table, bool $exists)

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

Параметры

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

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

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

Параметры

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)

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

Параметры

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

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

Spec-Zone.ru

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