-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathModuleModel.php
More file actions
121 lines (100 loc) · 2.14 KB
/
ModuleModel.php
File metadata and controls
121 lines (100 loc) · 2.14 KB
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<?php
namespace SyncEngine\Model;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Serializer\Attribute\Ignore;
use SyncEngine\Model\Interface\Installable;
use SyncEngine\Service\Locator\Modules;
abstract class ModuleModel implements Installable
{
const AUTHOR = '';
const VERSION = '';
/**
* Human-readable name used in the interface.
*
* @var string
*/
public string $name = '';
/**
* Human-readable description used in the interface.
*
* @var string
*/
public string $description = '';
/**
* Icon used in the interface.
*
* @var string
*/
public string $icon = '';
public function __construct()
{
// Construct.
}
public function install(): bool
{
return true;
}
public function uninstall(): bool
{
return true;
}
public function update( string $previousVersion ): bool
{
return true;
}
public function handleRequest( Request $request ): ?Response
{
return null;
}
public function renderRequest( Request $request ): Response|array|null
{
return null;
}
public function getName(): string
{
return $this->name;
}
public function getDescription(): string
{
return $this->description;
}
public function getIcon(): string
{
return $this->icon;
}
public function getAuthor(): string
{
return $this::AUTHOR;
}
public function getVersion(): string
{
return $this::VERSION;
}
final public function normalize()
{
return [
'name' => $this->getName(),
'description' => $this->getDescription(),
'icon' => $this->getIcon(),
'version' => $this->getVersion(),
'author' => $this->getAuthor(),
'_vendor' => Modules::getModuleVendor( $this ),
'_module' => Modules::getModuleName( $this ),
'_package' => Modules::getModulePackageName( $this ),
];
}
final static function isModule( $class ): bool
{
return $class instanceof ModuleModel;
}
#[Ignore]
final public function getClassLocator(): string
{
return static::_getClassLocator();
}
final public static function _getClassLocator(): string
{
return Modules::getModulePackageName( static::class );
}
}