Notification
class Notification extends AbstractModel
Models a notification record in the database.
A notification record is associated with a user, and shows up in their notification list. A notification indicates that something has happened that the user should know about, like if a user's discussion was renamed by someone else.
Each notification record has a type. The type determines how the record
looks in the notifications list, and what subject is associated with it.
For example, the 'discussionRenamed' notification type represents that
someone renamed a user's discussion. Its subject is a discussion, of which
the ID is stored in the subject_id column.
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 | $tableAlias | <p>An alias for the table name, used in queries.</p> | from AbstractModel |
|
| protected | $casts |
|
||
| static protected AbstractModel>> | $subjectModels | <p>A map of notification types and the model classes to use for their subjects. For example, the 'discussionRenamed' notification type, which represents that a user's discussion was renamed, has the subject model class 'Flarum\Discussion\Discussion'.</p> |
|
|
| int | $id |
|
||
| int | $user_id |
|
||
| int|null | $from_user_id |
|
||
| string | $type |
|
||
| int|null | $subject_id |
|
||
| array|null | $data |
|
||
| Carbon | $created_at |
|
||
| Carbon | $read_at |
|
||
| Carbon | $deleted_at |
|
||
| User|null | $user |
|
||
| User|null | $fromUser |
|
||
| AbstractModel|Post|Discussion|null | $subject |
|
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>Get the subject model for this notification record by looking up its type in our subject model map.</p>
<p>Scope the query to include only notifications whose subjects are visible to the given user.</p>
<p>Scope the query to include only notifications that have the given subject.</p>
<p>Scope the query to include only notification types that use the given subject model.</p>
<p>Scope the query to find all records matching the given blueprint.</p>
<p>Send notifications to the given recipients.</p>
<p>Set the subject model for the given notification type.</p>
No description
Details
in AbstractModel
at
line 71
static
boot()
in AbstractModel
at
line 88
__construct(array $attributes = [])
in AbstractModel
at
line 103
array
getCasts()
in AbstractModel
at
line 118
getAttribute($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 143
protected mixed
getCustomRelation(string $name)
<p>Get a custom relation object.</p>
in AbstractModel
at
line 158
void
afterSave(callable $callback)
<p>Register a callback to be run once after the model is saved.</p>
in AbstractModel
at
line 166
void
afterDelete(callable $callback)
<p>Register a callback to be run once after the model is deleted.</p>
in AbstractModel
at
line 174
array
releaseAfterSaveCallbacks()
in AbstractModel
at
line 186
array
releaseAfterDeleteCallbacks()
in AbstractModel
at
line 195
__call($method, $parameters)
in AbstractModel
at
line 204
newModelQuery()
in AbstractModel
at
line 215
qualifyColumn($column)
in AbstractModel
at
line 224
mixed
withTableAlias(callable $callback)
in AbstractModel
at
line 236
Collection
newCollection(array $models = [])
in AbstractModel
at
line 241
__sleep()
at
line 72
void
read()
at
line 81
string|null
getSubjectModelAttribute()
<p>Get the subject model for this notification record by looking up its type in our subject model map.</p>
at
line 86
BelongsTo
user()
at
line 91
BelongsTo
fromUser()
at
line 99
MorphTo
subject()
at
line 108
Builder
scopeWhereSubjectVisibleTo(Builder $query, User $actor)
<p>Scope the query to include only notifications whose subjects are visible to the given user.</p>
at
line 138
Builder
scopeWhereSubject(Builder $query, AbstractModel $model)
<p>Scope the query to include only notifications that have the given subject.</p>
at
line 148
Builder
scopeWhereSubjectModel(Builder $query, string $class)
<p>Scope the query to include only notification types that use the given subject model.</p>
at
line 160
Builder
scopeMatchingBlueprint(Builder $query, BlueprintInterface $blueprint)
<p>Scope the query to find all records matching the given blueprint.</p>
at
line 170
static void
notify(array $recipients, BlueprintInterface $blueprint)
<p>Send notifications to the given recipients.</p>
at
line 188
static array
getSubjectModels()
<p>Get the type-to-subject-model map.</p>
at
line 200
static void
setSubjectModel(string $type, string $subjectModel)
<p>Set the subject model for the given notification type.</p>