-
Notifications
You must be signed in to change notification settings - Fork 46
/
UserActionsTrait.php
154 lines (129 loc) · 4.58 KB
/
UserActionsTrait.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
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
declare(strict_types=1);
namespace Atk4\Data\Model;
use Atk4\Core\Factory;
use Atk4\Data\Model;
trait UserActionsTrait
{
/** @var array<mixed> The seed used by addUserAction() method. */
protected $_defaultSeedUserAction = [UserAction::class];
/** @var array<string, UserAction> Collection of user actions - using key as action system name */
protected $userActions = [];
/**
* Register new user action for this model. By default UI will allow users to trigger actions
* from UI.
*
* @param array<mixed>|\Closure $seed
*/
public function addUserAction(string $name, $seed = []): UserAction
{
$this->assertIsModel();
if ($seed instanceof \Closure) {
$seed = ['callback' => $seed];
}
$seed = Factory::mergeSeeds($seed, $this->_defaultSeedUserAction);
$action = UserAction::fromSeed($seed);
$this->_addIntoCollection($name, $action, 'userActions');
return $action;
}
/**
* Returns true if user action with a corresponding name exists.
*/
public function hasUserAction(string $name): bool
{
if ($this->isEntity() && $this->getModel()->hasUserAction($name)) {
return true;
}
return $this->_hasInCollection($name, 'userActions');
}
private function addUserActionFromModel(string $name, UserAction $action): void
{
$this->assertIsEntity();
$action->getOwner()->assertIsModel(); // @phpstan-ignore-line
// clone action and store it in entity
$action = clone $action;
$action->unsetOwner();
$this->_addIntoCollection($name, $action, 'userActions');
}
/**
* Returns list of actions for this model. Can filter actions by records they apply to.
* It will also skip system user actions (where system === true).
*
* @param string $appliesTo e.g. UserAction::APPLIES_TO_ALL_RECORDS
*
* @return array<string, UserAction>
*/
public function getUserActions(string $appliesTo = null): array
{
$this->assertIsModel();
return array_filter($this->userActions, function (UserAction $action) use ($appliesTo) {
return !$action->system && ($appliesTo === null || $action->appliesTo === $appliesTo);
});
}
/**
* Returns one action object of this model. If action not defined, then throws exception.
*/
public function getUserAction(string $name): UserAction
{
if ($this->isEntity() && !$this->_hasInCollection($name, 'userActions') && $this->getModel()->hasUserAction($name)) {
$this->addUserActionFromModel($name, $this->getModel()->getUserAction($name));
}
return $this->_getFromCollection($name, 'userActions');
}
/**
* Remove specified action.
*
* @return $this
*/
public function removeUserAction(string $name)
{
$this->assertIsModel();
$this->_removeFromCollection($name, 'userActions');
return $this;
}
/**
* Execute specified action with specified arguments.
*
* @param mixed ...$args
*
* @return mixed
*/
public function executeUserAction(string $name, ...$args)
{
return $this->getUserAction($name)->execute(...$args);
}
protected function initUserActions(): void
{
// Declare our basic Crud actions for the model.
$this->addUserAction('add', [
'fields' => true,
'modifier' => UserAction::MODIFIER_CREATE,
'appliesTo' => UserAction::APPLIES_TO_NO_RECORDS,
'callback' => 'save',
'description' => 'Add ' . $this->getModelCaption(),
]);
$this->addUserAction('edit', [
'fields' => true,
'modifier' => UserAction::MODIFIER_UPDATE,
'appliesTo' => UserAction::APPLIES_TO_SINGLE_RECORD,
'callback' => 'save',
]);
$this->addUserAction('delete', [
'appliesTo' => UserAction::APPLIES_TO_SINGLE_RECORD,
'modifier' => UserAction::MODIFIER_DELETE,
'callback' => function (Model $entity) {
return $entity->delete();
},
]);
$this->addUserAction('validate', [
// 'appliesTo' => any!
'description' => 'Provided with modified values will validate them but will not save',
'modifier' => UserAction::MODIFIER_READ,
'fields' => true,
'system' => true, // don't show by default
'args' => [
'intent' => ['type' => 'string'],
],
]);
}
}