PHP Interface Flarum\Core\Notification\BlueprintInterface

Show file Open project: flarum/core Interface Usage Examples

Public Methods

Method Description
getData ( ) : array | null Get the data to be stored in the notification.
getSender ( ) : User | null Get the user that sent the notification.
getSubject ( ) : AbstractModel | null Get the model that is the subject of this activity.
getSubjectModel ( ) : string Get the name of the model class for the subject of this activity.
getType ( ) : string Get the serialized type of this activity.

Method Details

getData() public method

Get the data to be stored in the notification.
public getData ( ) : array | null
return array | null

getSender() public method

Get the user that sent the notification.
public getSender ( ) : User | null
return Flarum\Core\User | null

getSubject() public method

Get the model that is the subject of this activity.
public getSubject ( ) : AbstractModel | null
return Flarum\Database\AbstractModel | null

getSubjectModel() public static method

Get the name of the model class for the subject of this activity.
public static getSubjectModel ( ) : string
return string

getType() public static method

Get the serialized type of this activity.
public static getType ( ) : string
return string