class UserState extends AbstractModel
Models a discussion-user state record in the database.
Stores information about how much of a discussion a user has read. Can also be used to store other information, if the appropriate columns are added to the database, like a user's subscription status for a discussion.
Traits
Properties
bool | $timestamps | <p>Indicates if the model should be timestamped. Turn off by default.</p> | from AbstractModel | |
protected callable[] | $afterSaveCallbacks | <p>An array of callbacks to be run once after the model is saved.</p> | from AbstractModel | |
protected callable[] | $afterDeleteCallbacks | <p>An array of callbacks to be run once after the model is deleted.</p> | from AbstractModel | |
static | $customRelations | from AbstractModel | ||
static | $customCasts | from AbstractModel | ||
static | $defaults | from AbstractModel | ||
protected string|null | $tableAlias | <p>An alias for the table name, used in queries.</p> | from AbstractModel | |
int|null | $id | from AbstractModel | ||
protected array | $pendingEvents | from EventGeneratorTrait | ||
protected | $table | <p>{@inheritdoc}</p> | ||
protected array | $dates | <p>The attributes that should be mutated to dates.</p> | ||
protected string[] | $fillable | <p>The attributes that are mass assignable.</p> | ||
int | $user_id | |||
int | $discussion_id | |||
Carbon|null | $last_read_at | |||
int|null | $last_read_post_number | |||
Discussion | $discussion | |||
User | $user |
Methods
<p>Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.</p>
<p>Register a callback to be run once after the model is saved.</p>
<p>Register a callback to be run once after the model is deleted.</p>
<p>Mark the discussion as being read up to a certain point. Raises the DiscussionWasRead event.</p>
Details
in AbstractModel
at
line 77
static
boot()
<p>{@inheritdoc}</p>
in AbstractModel
at
line 97
__construct(array $attributes = [])
<p>{@inheritdoc}</p>
in AbstractModel
at
line 115
getCasts()
<p>{@inheritdoc}</p>
in AbstractModel
at
line 133
mixed
getAttribute(string $key)
<p>Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.</p>
in AbstractModel
at
line 159
protected mixed
getCustomRelation(string $name)
<p>Get a custom relation object.</p>
in AbstractModel
at
line 175
void
afterSave(callable $callback)
<p>Register a callback to be run once after the model is saved.</p>
in AbstractModel
at
line 186
void
afterDelete(callable $callback)
<p>Register a callback to be run once after the model is deleted.</p>
in AbstractModel
at
line 194
callable[]
releaseAfterSaveCallbacks()
in AbstractModel
at
line 206
callable[]
releaseAfterDeleteCallbacks()
in AbstractModel
at
line 218
__call($method, $arguments)
<p>{@inheritdoc}</p>
in AbstractModel
at
line 227
newModelQuery()
in AbstractModel
at
line 238
qualifyColumn($column)
in AbstractModel
at
line 247
withTableAlias(callable $callback)
in AbstractModel
at
line 262
newCollection(Collection|array $models = [])
in EventGeneratorTrait
at
line 24
raise(mixed $event)
<p>Raise a new event.</p>
in EventGeneratorTrait
at
line 34
array
releaseEvents()
<p>Return and reset all pending events.</p>
at
line 63
$this
read(int $number)
<p>Mark the discussion as being read up to a certain point. Raises the DiscussionWasRead event.</p>
at
line 80
BelongsTo
discussion()
<p>Define the relationship with the discussion that this state is for.</p>
at
line 90
BelongsTo
user()
<p>Define the relationship with the user that this state is for.</p>
at
line 101
protected Builder
setKeysForSaveQuery(Builder $query)
<p>Set the keys for a save update query.</p>