-
Notifications
You must be signed in to change notification settings - Fork 67
/
BlockEntity.php
304 lines (258 loc) · 6.79 KB
/
BlockEntity.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
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
<?php
declare(strict_types=1);
/*
* This file is part of the Zikula package.
*
* Copyright Zikula Foundation - https://ziku.la/
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Zikula\BlocksModule\Entity;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Zikula\BlocksModule\Api\BlockApi;
use Zikula\Core\Doctrine\EntityAccess;
use Zikula\ExtensionsModule\Entity\ExtensionEntity;
/**
* Block entity class.
*
* @ORM\Entity(repositoryClass="Zikula\BlocksModule\Entity\Repository\BlockRepository")
* @ORM\Table(name="blocks",indexes={@ORM\Index(name="active_idx",columns={"active"})})
*/
class BlockEntity extends EntityAccess
{
/**
* The block id
*
* @ORM\Id
* @ORM\Column(type="integer")
* @ORM\GeneratedValue(strategy="AUTO")
*/
private $bid;
/**
* The block key
*
* @Assert\NotBlank()
* @ORM\Column(type="string", length=255)
*/
private $bkey;
/**
* @Assert\NotBlank()
* @ORM\Column(type="string", length=255)
*/
private $blocktype;
/**
* The block title
*
* @ORM\Column(type="string", length=255)
*/
private $title;
/**
* The block description
*
* @ORM\Column(type="text")
*/
private $description;
/**
* A serialized array of block properties
*
* @ORM\Column(type="array")
*/
private $properties;
/**
* The id of the module owning the block
*
* @var ExtensionEntity
* @ORM\ManyToOne(targetEntity="Zikula\ExtensionsModule\Entity\ExtensionEntity")
* @ORM\JoinColumn(name="mid", referencedColumnName="id")
*/
private $module;
/**
* The display filter to apply to the block
*
* @ORM\Column(name="filter", type="array")
*/
private $filters;
/**
* The active status of the block
*
* @ORM\Column(type="integer")
*/
private $active;
/**
* The last updated timestamp of the block
*
* @ORM\Column(type="datetime")
*/
private $last_update;
/**
* The language of the block
*
* @ORM\Column(type="string", length=30)
*/
private $language;
/**
* @ORM\OneToMany(
* targetEntity="Zikula\BlocksModule\Entity\BlockPlacementEntity",
* mappedBy="block",
* cascade={"remove", "persist"},
* orphanRemoval=true)
*/
private $placements;
public function __construct()
{
$this->bkey = '';
$this->title = '';
$this->description = '';
$this->blocktype = '';
$this->properties = [];
$this->module = 0;
$this->filters = [];
$this->active = BlockApi::BLOCK_ACTIVE;
$this->last_update = new DateTime('now');
$this->language = '';
$this->placements = new ArrayCollection();
}
public function getBid(): int
{
return $this->bid;
}
public function setBid(int $bid): void
{
$this->bid = $bid;
}
public function getBkey(): string
{
return $this->bkey;
}
public function setBkey(string $bkey): void
{
$this->bkey = $bkey;
}
public function getBlocktype(): string
{
return $this->blocktype;
}
public function setBlocktype(string $blocktype): void
{
$this->blocktype = $blocktype;
}
public function getTitle(): string
{
return $this->title;
}
public function setTitle(string $title): void
{
$this->title = $title;
}
public function getDescription(): string
{
return $this->description;
}
public function setDescription(string $description): void
{
$this->description = $description;
}
public function getProperties(): array
{
return $this->properties;
}
public function setProperties(array $properties = []): void
{
$this->properties = $properties;
}
public function getModule(): ExtensionEntity
{
return $this->module;
}
public function setModule(ExtensionEntity $module): void
{
$this->module = $module;
}
public function getFilters(): array
{
return $this->filters;
}
public function setFilters(array $filters = []): void
{
$this->filters = $filters;
}
public function getActive(): int
{
return $this->active;
}
public function setActive(int $active): void
{
$this->active = $active;
}
public function getLast_Update(): DateTime
{
return $this->last_update;
}
public function setLast_Update(): void
{
$this->last_update = new DateTime('now');
}
public function getLanguage(): string
{
return $this->language;
}
public function setLanguage(string $language): void
{
$this->language = $language;
}
public function getPlacements(): Collection
{
return $this->placements;
}
public function addPlacement(BlockPlacementEntity $placement): void
{
if (!$this->placements->contains($placement)) {
$this->placements->add($placement);
}
}
public function removePlacement(BlockPlacementEntity $placement): void
{
if ($this->placements->contains($placement)) {
$this->placements->removeElement($placement);
}
}
public function getPositions(): ArrayCollection
{
$positions = new ArrayCollection();
foreach ($this->getPlacements() as $placement) {
$positions->add($placement->getPosition());
}
return $positions;
}
/**
* Set BlockPlacementsEntity from provided ArrayCollection of positionEntity
* requires
* cascade={"remove, "persist"}
* orphanRemoval=true
* on the association of $this->placements
*/
public function setPositions(ArrayCollection $positions): void
{
// remove placements and skip existing placements.
foreach ($this->placements as $placement) {
if (!$positions->contains($placement->getPosition())) {
$this->placements->removeElement($placement);
} else {
// remove from positions to add
$positions->removeElement($placement->getPosition());
}
}
// add new placements
foreach ($positions as $position) {
$placement = new BlockPlacementEntity();
$placement->setPosition($position);
// sortorder is irrelevant at this stage.
$placement->setBlock($this); // auto-adds placement
}
}
}