/
BlueprintInterface.php
56 lines (48 loc) · 1.2 KB
/
BlueprintInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?php
/*
* This file is part of Flarum.
*
* For detailed copyright and license information, please view the
* LICENSE file that was distributed with this source code.
*/
namespace Flarum\Notification\Blueprint;
use Flarum\Database\AbstractModel;
use Flarum\User\User;
/**
* A notification BlueprintInterface, when instantiated, represents a notification about
* something. The blueprint is used by the NotificationSyncer to commit the
* notification to the database.
*/
interface BlueprintInterface
{
/**
* Get the user that sent the notification.
*
* @return User|null
*/
public function getFromUser();
/**
* Get the model that is the subject of this activity.
*
* @return AbstractModel|null
*/
public function getSubject();
/**
* Get the data to be stored in the notification.
*
* @return array|null
*/
public function getData();
/**
* Get the serialized type of this activity.
*
* @return string
*/
public static function getType();
/**
* Get the name of the model class for the subject of this activity.
*
* @return string
*/
public static function getSubjectModel();
}