Discussion  

class Discussion extends AbstractModel

Traits

EventGeneratorTrait
ScopeVisibilityTrait

Properties

bool $timestamps Indicates if the model should be timestamped. Turn off by default. from AbstractModel
protected callable[] $afterSaveCallbacks An array of callbacks to be run once after the model is saved. from AbstractModel
protected callable[] $afterDeleteCallbacks An array of callbacks to be run once after the model is deleted. from AbstractModel
static $customRelations from AbstractModel
static $dateAttributes from AbstractModel
static $defaults from AbstractModel
protected array $pendingEvents from EventGeneratorTrait
static protected $visibilityScopers from ScopeVisibilityTrait
protected array $modifiedPosts An array of posts that have been modified during this request.
protected array $dates The attributes that should be mutated to dates.
protected array $casts The attributes that should be cast to native types.
static protected User $stateUser The user for which the state relationship should be loaded.
int $id
string $title
string $slug
int $comment_count
int $participant_count
int $post_number_index !!DEPRECATED!!
Carbon $created_at
int|null $user_id
int|null $first_post_id
Carbon|null $last_posted_at
int|null $last_posted_user_id
int|null $last_post_id
int|null $last_post_number
Carbon|null $hidden_at
int|null $hidden_user_id
UserState|null $state
Collection $posts
Collection $comments
Collection $participants
Post|null $firstPost
User|null $user
Post|null $lastPost
User|null $lastPostedUser
Collection $readers
bool $is_private

Methods

static 
boot()

Boot the model.

__construct(array $attributes = [])

{@inheritdoc}

from AbstractModel
array
getDates()

Get the attributes that should be converted to dates.

from AbstractModel
mixed
getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

from AbstractModel
mixed
getCustomRelation(string $name)

Get a custom relation object.

from AbstractModel
void
afterSave(callable $callback)

Register a callback to be run once after the model is saved.

from AbstractModel
void
afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

from AbstractModel
callable[]
releaseAfterSaveCallbacks()

No description

from AbstractModel
callable[]
releaseAfterDeleteCallbacks()

No description

from AbstractModel
__call($method, $arguments)

{@inheritdoc}

from AbstractModel
raise(mixed $event)

Raise a new event.

from EventGeneratorTrait
array
releaseEvents()

Return and reset all pending events.

from EventGeneratorTrait
static 
registerVisibilityScoper($scoper, $ability = null)

No description

from ScopeVisibilityTrait
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

Scope a query to only include records that are visible to a user.

from ScopeVisibilityTrait
static Discussion
start(string $title, User $user)

Start a new discussion. Raises the DiscussionWasStarted event.

$this
rename(string $title)

Rename the discussion. Raises the DiscussionWasRenamed event.

$this
hide(User $actor = null)

Hide the discussion.

$this
restore()

Restore the discussion.

$this
setFirstPost(Post $post)

Set the discussion's first post details.

$this
setLastPost(Post $post)

Set the discussion's last post details.

$this
refreshLastPost()

Refresh a discussion's last post details.

$this
refreshCommentCount()

Refresh the discussion's comment count.

$this
refreshParticipantCount()

Refresh the discussion's participant count.

Post
mergePost(MergeableInterface $post)

Save a post, attempting to merge it with the discussion's last post.

array
getModifiedPosts()

Get the posts that have been modified during this request.

HasMany
posts()

Define the relationship with the discussion's posts.

HasMany
comments()

Define the relationship with the discussion's publicly-visible comments.

Builder
participants()

Query the discussion's participants (a list of unique users who have posted in the discussion).

BelongsTo
firstPost()

Define the relationship with the discussion's first post.

BelongsTo
user()

Define the relationship with the discussion's author.

BelongsTo
lastPost()

Define the relationship with the discussion's last post.

BelongsTo
lastPostedUser()

Define the relationship with the discussion's most recent author.

BelongsTo
mostRelevantPost()

Define the relationship with the discussion's most relevant post.

BelongsToMany
readers()

Define the relationship with the discussion's readers.

HasOne
state(User $user = null)

Define the relationship with the discussion's state for a particular user.

UserState
stateFor(User $user)

Get the state model for a user, or instantiate a new one if it does not exist.

static 
setStateUser(User $user)

Set the user for which the state relationship should be loaded.

setTitleAttribute(string $title)

Set the discussion title.

Details

at line 95
static boot()

Boot the model.

in AbstractModel at line 85
__construct(array $attributes = [])

{@inheritdoc}

Parameters

array $attributes

in AbstractModel at line 105
array getDates()

Get the attributes that should be converted to dates.

Return Value

array

in AbstractModel at line 123
mixed getAttribute(string $key)

Get an attribute from the model. If nothing is found, attempt to load a custom relation method with this key.

Parameters

string $key

Return Value

mixed

in AbstractModel at line 149
protected mixed getCustomRelation(string $name)

Get a custom relation object.

Parameters

string $name

Return Value

mixed

in AbstractModel at line 165
void afterSave(callable $callback)

Register a callback to be run once after the model is saved.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 176
void afterDelete(callable $callback)

Register a callback to be run once after the model is deleted.

Parameters

callable $callback

Return Value

void

in AbstractModel at line 184
callable[] releaseAfterSaveCallbacks()

Return Value

callable[]

in AbstractModel at line 196
callable[] releaseAfterDeleteCallbacks()

Return Value

callable[]

in AbstractModel at line 208
__call($method, $arguments)

{@inheritdoc}

Parameters

$method
$arguments

in EventGeneratorTrait at line 24
raise(mixed $event)

Raise a new event.

Parameters

mixed $event

in EventGeneratorTrait at line 34
array releaseEvents()

Return and reset all pending events.

Return Value

array

in ScopeVisibilityTrait at line 20
static registerVisibilityScoper($scoper, $ability = null)

Parameters

$scoper
$ability

in ScopeVisibilityTrait at line 41
scopeWhereVisibleTo(Builder $query, User $actor, string $ability = 'view')

Scope a query to only include records that are visible to a user.

Parameters

Builder $query
User $actor
string $ability

at line 121
static Discussion start(string $title, User $user)

Start a new discussion. Raises the DiscussionWasStarted event.

Parameters

string $title
User $user

Return Value

Discussion

at line 142
$this rename(string $title)

Rename the discussion. Raises the DiscussionWasRenamed event.

Parameters

string $title

Return Value

$this

at line 160
$this hide(User $actor = null)

Hide the discussion.

Parameters

User $actor

Return Value

$this

at line 177
$this restore()

Restore the discussion.

Return Value

$this

at line 195
$this setFirstPost(Post $post)

Set the discussion's first post details.

Parameters

Post $post

Return Value

$this

at line 210
$this setLastPost(Post $post)

Set the discussion's last post details.

Parameters

Post $post

Return Value

$this

at line 225
$this refreshLastPost()

Refresh a discussion's last post details.

Return Value

$this

at line 240
$this refreshCommentCount()

Refresh the discussion's comment count.

Return Value

$this

at line 252
$this refreshParticipantCount()

Refresh the discussion's participant count.

Return Value

$this

at line 272
Post mergePost(MergeableInterface $post)

Save a post, attempting to merge it with the discussion's last post.

The merge logic is delegated to the new post. (As an example, a DiscussionRenamedPost will merge if adjacent to another DiscussionRenamedPost, and delete if the title has been reverted completely.)

Parameters

MergeableInterface $post The post to save.

Return Value

Post The resulting post. It may or may not be the same post as was originally intended to be saved. It also may not exist, if the merge logic resulted in deletion.

at line 286
array getModifiedPosts()

Get the posts that have been modified during this request.

Return Value

array

at line 296
HasMany posts()

Define the relationship with the discussion's posts.

Return Value

HasMany

at line 306
HasMany comments()

Define the relationship with the discussion's publicly-visible comments.

Return Value

HasMany

at line 320
Builder participants()

Query the discussion's participants (a list of unique users who have posted in the discussion).

Return Value

Builder

at line 335
BelongsTo firstPost()

Define the relationship with the discussion's first post.

Return Value

BelongsTo

at line 345
BelongsTo user()

Define the relationship with the discussion's author.

Return Value

BelongsTo

at line 355
BelongsTo lastPost()

Define the relationship with the discussion's last post.

Return Value

BelongsTo

at line 365
BelongsTo lastPostedUser()

Define the relationship with the discussion's most recent author.

Return Value

BelongsTo

at line 375
BelongsTo mostRelevantPost()

Define the relationship with the discussion's most relevant post.

Return Value

BelongsTo

at line 385
BelongsToMany readers()

Define the relationship with the discussion's readers.

Return Value

BelongsToMany

at line 402
HasOne state(User $user = null)

Define the relationship with the discussion's state for a particular user.

If no user is passed (i.e. in the case of eager loading the 'state' relation), then the static `$stateUser` property is used.

Parameters

User $user

Return Value

HasOne

See also

Discussion::setStateUser

at line 416
UserState stateFor(User $user)

Get the state model for a user, or instantiate a new one if it does not exist.

Parameters

User $user

Return Value

UserState

at line 434
static setStateUser(User $user)

Set the user for which the state relationship should be loaded.

Parameters

User $user

at line 447
protected setTitleAttribute(string $title)

Set the discussion title.

This automatically creates a matching slug for the discussion.

Parameters

string $title