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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
<?php
/*
* Spring Signage Ltd - http://www.springsignage.com
* Copyright (C) 2015 Spring Signage Ltd
* (Command.php)
*/
namespace Xibo\Entity;
use Respect\Validation\Validator as v;
use Xibo\Exception\InvalidArgumentException;
use Xibo\Factory\DisplayProfileFactory;
use Xibo\Service\LogServiceInterface;
use Xibo\Storage\StorageServiceInterface;
/**
* Class Command
* @package Xibo\Entity
*
* @SWG\Definition()
*/
class Command implements \JsonSerializable
{
use EntityTrait;
/**
* @SWG\Property(
* description="Command Id"
* )
* @var int
*/
public $commandId;
/**
* @SWG\Property(
* description="Command Name"
* )
* @var string
*/
public $command;
/**
* @SWG\Property(
* description="Unique Code"
* )
* @var string
*/
public $code;
/**
* @SWG\Property(
* description="Description"
* )
* @var string
*/
public $description;
/**
* @SWG\Property(
* description="User Id"
* )
* @var int
*/
public $userId;
/**
* @SWG\Property(
* description="Command String - when child of a Display Profile"
* )
* @var string
*/
public $commandString;
/**
* @SWG\Property(
* description="Validation String - when child of a Display Profile"
* )
* @var string
*/
public $validationString;
/**
* Display Profiles using this command
* @var array[DisplayProfile]
*/
private $displayProfiles = [];
/**
* @var DisplayProfileFactory
*/
private $displayProfileFactory;
/**
* Command constructor.
* @param StorageServiceInterface $store
* @param LogServiceInterface $log
*/
public function __construct($store, $log)
{
$this->setCommonDependencies($store, $log);
}
/**
* @param DisplayProfileFactory $displayProfileFactory
*/
public function setChildObjectDependencies($displayProfileFactory)
{
$this->displayProfileFactory = $displayProfileFactory;
}
/**
* Get Id
* @return int
*/
public function getId()
{
return $this->commandId;
}
/**
* Get OwnerId
* @return int
*/
public function getOwnerId()
{
return $this->userId;
}
/**
* Validate
*/
public function validate()
{
if (!v::string()->notEmpty()->length(1, 254)->validate($this->command))
throw new InvalidArgumentException(__('Please enter a command name between 1 and 254 characters'), 'command');
if (!v::alpha()->NoWhitespace()->notEmpty()->length(1, 50)->validate($this->code))
throw new InvalidArgumentException(__('Please enter a code between 1 and 50 characters containing only alpha characters and no spaces'), 'code');
if (!v::string()->notEmpty()->length(1, 1000)->validate($this->description))
throw new InvalidArgumentException(__('Please enter a description between 1 and 1000 characters'), 'description');
}
/**
* Load
* @param array $options
*/
public function load($options = [])
{
if ($this->loaded || $this->commandId == null)
return;
$this->displayProfiles = $this->displayProfileFactory->getByCommandId($this->commandId);
}
/**
* Save
* @param array $options
*/
public function save($options = [])
{
$options = array_merge($options, ['validate' => true]);
if ($options['validate'])
$this->validate();
if ($this->commandId == null)
$this->add();
else
$this->edit();
}
/**
* Delete
*/
public function delete()
{
if (!$this->loaded)
$this->load();
// Remove from any display profiles
foreach ($this->displayProfiles as $profile) {
/* @var \Xibo\Entity\DisplayProfile $profile */
$profile->unassignCommand($this);
$profile->save(['validate' => false]);
}
$this->getStore()->update('DELETE FROM `command` WHERE `commandId` = :commandId', ['commandId' => $this->commandId]);
}
private function add()
{
$this->commandId = $this->getStore()->insert('INSERT INTO `command` (`command`, `code`, `description`, `userId`) VALUES (:command, :code, :description, :userId)', [
'command' => $this->command,
'code' => $this->code,
'description' => $this->description,
'userId' => $this->userId
]);
}
private function edit()
{
$this->getStore()->update('
UPDATE `command` SET
`command` = :command,
`code` = :code,
`description` = :description,
`userId` = :userId
WHERE `commandId` = :commandId
', [
'command' => $this->command,
'code' => $this->code,
'description' => $this->description,
'userId' => $this->userId,
'commandId' => $this->commandId
]);
}
}
|