CommentPost  

class CommentPost extends Post

A standard comment in a discussion.

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 $customCasts from AbstractModel
static $defaults from AbstractModel
int $id from Post
protected array $pendingEvents from EventGeneratorTrait
static protected $visibilityScopers from ScopeVisibilityTrait
protected $table from Post
protected array $dates The attributes that should be mutated to dates. from Post
protected array $casts The attributes that should be cast to native types. from Post
static protected array $models A map of post types, as specified in the `type` column, to their classes. from Post
static $type {@inheritdoc}
int $discussion_id from Post
int|Expression $number from Post
Carbon $created_at from Post
int|null $user_id from Post
string|null $content from Post
Carbon|null $edited_at from Post
int|null $edited_user_id from Post
Carbon|null $hidden_at from Post
int|null $hidden_user_id from Post
Discussion|null $discussion from Post
User|null $user from Post
User|null $editedUser from Post
User|null $hiddenUser from Post
string $ip_address from Post
bool $is_private from Post
static protected Formatter $formatter The text formatter instance.
string $parsed_content

Methods

static 
boot()

{@inheritdoc}

from Post
__construct(array $attributes = [])

{@inheritdoc}

from AbstractModel
getCasts()

{@inheritdoc}

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
bool
isVisibleTo(User $user)

Determine whether or not this post is visible to the given user.

from Post
BelongsTo
discussion()

Define the relationship with the post's discussion.

from Post
BelongsTo
user()

Define the relationship with the post's author.

from Post
BelongsTo
editedUser()

Define the relationship with the user who edited the post.

from Post
BelongsTo
hiddenUser()

Define the relationship with the user who hid the post.

from Post
Builder
scopeAllTypes(Builder $query)

Get all posts, regardless of their type, by removing the `RegisteredTypesScope` global scope constraints applied on this model.

from Post
Post|object
newFromBuilder(array $attributes = [], string|null $connection = null)

Create a new model instance according to the post's type.

from Post
static array
getModels()

Get the type-to-model map.

from Post
static void
setModel(string $type, string $model)

Set the model for the given post type.

from Post
static CommentPost
reply(int $discussionId, string $content, int $userId, string $ipAddress, User $actor = null)

Create a new instance in reply to a discussion.

$this
revise(string $content, User $actor)

Revise the post's content.

$this
hide(User $actor = null)

Hide the post.

$this
restore()

Restore the post.

string
getContentAttribute(string $value)

Unparse the parsed content.

string
getParsedContentAttribute()

Get the parsed/raw content.

setContentAttribute(string $value, User $actor = null)

Parse the content before it is saved to the database.

setParsedContentAttribute(string $value)

Set the parsed/raw content.

string
formatContent(ServerRequestInterface $request = null)

Get the content rendered as HTML.

static Formatter
getFormatter()

Get the text formatter instance.

static 
setFormatter(Formatter $formatter)

Set the text formatter instance.

Details

in Post at line 86
static boot()

{@inheritdoc}

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

{@inheritdoc}

Parameters

array $attributes

in AbstractModel at line 105
getCasts()

{@inheritdoc}

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

in Post at line 127
bool isVisibleTo(User $user)

Determine whether or not this post is visible to the given user.

Parameters

User $user

Return Value

bool

in Post at line 137
BelongsTo discussion()

Define the relationship with the post's discussion.

Return Value

BelongsTo

in Post at line 147
BelongsTo user()

Define the relationship with the post's author.

Return Value

BelongsTo

in Post at line 157
BelongsTo editedUser()

Define the relationship with the user who edited the post.

Return Value

BelongsTo

in Post at line 167
BelongsTo hiddenUser()

Define the relationship with the user who hid the post.

Return Value

BelongsTo

in Post at line 179
Builder scopeAllTypes(Builder $query)

Get all posts, regardless of their type, by removing the `RegisteredTypesScope` global scope constraints applied on this model.

Parameters

Builder $query

Return Value

Builder

in Post at line 191
Post|object newFromBuilder(array $attributes = [], string|null $connection = null)

Create a new model instance according to the post's type.

Parameters

array $attributes
string|null $connection

Return Value

Post|object

in Post at line 216
static array getModels()

Get the type-to-model map.

Return Value

array

in Post at line 230
static void setModel(string $type, string $model)

Set the model for the given post type.

Parameters

string $type The post type.
string $model The class name of the model for that type.

Return Value

void

at line 50
static CommentPost reply(int $discussionId, string $content, int $userId, string $ipAddress, User $actor = null)

Create a new instance in reply to a discussion.

Parameters

int $discussionId
string $content
int $userId
string $ipAddress
User $actor

Return Value

CommentPost

at line 75
$this revise(string $content, User $actor)

Revise the post's content.

Parameters

string $content
User $actor

Return Value

$this

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

Hide the post.

Parameters

User $actor

Return Value

$this

at line 112
$this restore()

Restore the post.

Return Value

$this

at line 130
string getContentAttribute(string $value)

Unparse the parsed content.

Parameters

string $value

Return Value

string

at line 140
string getParsedContentAttribute()

Get the parsed/raw content.

Return Value

string

at line 151
setContentAttribute(string $value, User $actor = null)

Parse the content before it is saved to the database.

Parameters

string $value
User $actor

at line 161
setParsedContentAttribute(string $value)

Set the parsed/raw content.

Parameters

string $value

at line 172
string formatContent(ServerRequestInterface $request = null)

Get the content rendered as HTML.

Parameters

ServerRequestInterface $request

Return Value

string

at line 182
static Formatter getFormatter()

Get the text formatter instance.

Return Value

Formatter

at line 192
static setFormatter(Formatter $formatter)

Set the text formatter instance.

Parameters

Formatter $formatter