Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
63.49%
80 / 126
47.92%
23 / 48
 CRAP
0.00%
0 / 1
Scope
63.49%
80 / 126
47.92%
23 / 48
 464.81
0.00%
0 / 1
 getDefaults
100.00%
8 / 8
100.00%
1 / 1
 1
 getSource
100.00%
1 / 1
100.00%
1 / 1
 1
 getShortName
0.00%
0 / 1
0.00%
0 / 1
 2
 getEmailFrom
0.00%
0 / 1
0.00%
0 / 1
 2
 getEmailRequired
0.00%
0 / 1
0.00%
0 / 1
 2
 getTelephoneActivated
0.00%
0 / 1
0.00%
0 / 1
 2
 getTelephoneRequired
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfieldActivated
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfieldRequired
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfieldLabel
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfield2Activated
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfield2Required
0.00%
0 / 1
0.00%
0 / 1
 2
 getCustomTextfield2Label
0.00%
0 / 1
0.00%
0 / 1
 2
 getCaptchaActivatedRequired
0.00%
0 / 1
0.00%
0 / 1
 2
 getInfoForAppointment
0.00%
0 / 1
0.00%
0 / 1
 2
 getInfoForAllAppointments
0.00%
0 / 1
0.00%
0 / 1
 2
 getProvider
66.67%
6 / 9
0.00%
0 / 1
 5.93
 getProviderId
100.00%
1 / 1
100.00%
1 / 1
 1
 getDayoffList
28.57%
2 / 7
0.00%
0 / 1
 24.86
 getClosureList
0.00%
0 / 7
0.00%
0 / 1
 56
 getRequestList
100.00%
1 / 1
100.00%
1 / 1
 1
 getPreference
100.00%
2 / 2
100.00%
1 / 1
 3
 getStatus
100.00%
1 / 1
100.00%
1 / 1
 1
 getContactEmail
100.00%
1 / 1
100.00%
1 / 1
 1
 getName
100.00%
1 / 1
100.00%
1 / 1
 1
 getScopeInfo
100.00%
1 / 1
100.00%
1 / 1
 1
 getScopeHint
100.00%
1 / 1
100.00%
1 / 1
 1
 getDisplayNumberPrefix
0.00%
0 / 1
0.00%
0 / 1
 2
 getAlternateRedirectUrl
0.00%
0 / 2
0.00%
0 / 1
 6
 getAppointmentsPerMail
0.00%
0 / 2
0.00%
0 / 1
 6
 getSlotsPerAppointment
0.00%
0 / 2
0.00%
0 / 1
 6
 getWhitelistedMails
0.00%
0 / 2
0.00%
0 / 1
 6
 getReservationDuration
0.00%
0 / 1
0.00%
0 / 1
 2
 getWaitingTimeFromQueueList
100.00%
5 / 5
100.00%
1 / 1
 1
 getCalculatedWorkstationCount
100.00%
6 / 6
100.00%
1 / 1
 4
 getBookableStartDate
100.00%
3 / 3
100.00%
1 / 1
 2
 getBookableEndDate
100.00%
3 / 3
100.00%
1 / 1
 2
 updateStatusQueue
100.00%
13 / 13
100.00%
1 / 1
 4
 incrementDisplayNumber
0.00%
0 / 5
0.00%
0 / 1
 6
 hasEmailFrom
100.00%
2 / 2
100.00%
1 / 1
 2
 isEmailRequired
100.00%
3 / 3
100.00%
1 / 1
 3
 isTelephoneRequired
0.00%
0 / 2
0.00%
0 / 1
 6
 hasAccess
100.00%
1 / 1
100.00%
1 / 1
 2
 withLessData
100.00%
8 / 8
100.00%
1 / 1
 5
 setStatusQueue
100.00%
2 / 2
100.00%
1 / 1
 1
 setStatusAvailability
100.00%
2 / 2
100.00%
1 / 1
 1
 isNewerThan
100.00%
1 / 1
100.00%
1 / 1
 1
 __toString
100.00%
5 / 5
100.00%
1 / 1
 1
1<?php
2
3namespace BO\Zmsentities;
4
5use BO\Zmsdb\Process;
6use BO\Zmsentities\Collection\ClosureList;
7use BO\Zmsentities\Collection\DayoffList;
8
9/**
10 * @SuppressWarnings(Complexity)
11 */
12class Scope extends Schema\Entity implements Useraccount\AccessInterface
13{
14    public const PRIMARY = 'id';
15
16    public static $schema = "scope.json";
17
18    #[\Override]
19    public function getDefaults()
20    {
21        return [
22            'id' => 0,
23            'source' => 'dldb',
24            'contact' => new Contact(),
25            'provider' => new Provider(),
26            'shortName' => '',
27            'dayoff' => new DayoffList()
28        ];
29    }
30
31    public function getSource()
32    {
33        return $this->toProperty()->source->get();
34    }
35
36    public function getShortName()
37    {
38        return $this->toProperty()->shortName->get();
39    }
40
41    public function getEmailFrom()
42    {
43        return $this->getPreference('client', 'emailFrom', null);
44    }
45
46    public function getEmailRequired()
47    {
48        return $this->getPreference('client', 'emailRequired', null);
49    }
50
51    public function getTelephoneActivated()
52    {
53        return $this->getPreference('client', 'telephoneActivated', null);
54    }
55
56    public function getTelephoneRequired()
57    {
58        return $this->getPreference('client', 'telephoneRequired', null);
59    }
60
61    public function getCustomTextfieldActivated()
62    {
63        return $this->getPreference('client', 'customTextfieldActivated', null);
64    }
65
66    public function getCustomTextfieldRequired()
67    {
68        return $this->getPreference('client', 'customTextfieldRequired', null);
69    }
70
71    public function getCustomTextfieldLabel()
72    {
73        return $this->getPreference('client', 'customTextfieldLabel', '');
74    }
75
76    public function getCustomTextfield2Activated()
77    {
78        return $this->getPreference('client', 'customTextfield2Activated', null);
79    }
80
81    public function getCustomTextfield2Required()
82    {
83        return $this->getPreference('client', 'customTextfield2Required', null);
84    }
85
86    public function getCustomTextfield2Label()
87    {
88        return $this->getPreference('client', 'customTextfield2Label', '');
89    }
90
91    public function getCaptchaActivatedRequired()
92    {
93        return $this->getPreference('client', 'captchaActivatedRequired', null);
94    }
95
96    public function getInfoForAppointment()
97    {
98        return $this->getPreference('appointment', 'infoForAppointment', null);
99    }
100
101    public function getInfoForAllAppointments()
102    {
103        return $this->getPreference('appointment', 'infoForAllAppointments', null);
104    }
105
106
107    public function getProvider()
108    {
109        if (!isset($this->provider)) {
110            throw new Exception\ScopeMissingProvider("Provider is missing", 500);
111        }
112        if (!$this->provider instanceof Provider) {
113            $this->provider = new Provider($this->toProperty()->provider->get());
114        }
115        if (!isset($this->provider['id']) || !$this->provider->id) {
116            $exception = new Exception\ScopeMissingProvider("No reference to a provider found for scope $this->id");
117            $exception->data['scope'] = $this->getArrayCopy();
118            throw $exception;
119        }
120        return $this->provider;
121    }
122
123    public function getProviderId()
124    {
125        return $this->getProvider()->id;
126    }
127
128    public function getDayoffList()
129    {
130        if (!isset($this->dayoff) || !$this->dayoff instanceof Collection\DayoffList) {
131            $this->dayoff = (!isset($this->dayoff) || !is_array($this->dayoff)) ? [] : $this->dayoff;
132            $this->dayoff = new Collection\DayoffList($this->dayoff);
133            foreach ($this->dayoff as $key => $dayoff) {
134                if (!$dayoff instanceof Dayoff) {
135                    $this->dayoff[$key] = new Dayoff($dayoff);
136                }
137            }
138        }
139        return $this->dayoff;
140    }
141
142    public function getClosureList()
143    {
144        if (!isset($this->closure) || !$this->closure instanceof Collection\ClosureList) {
145            $this->closure = (!isset($this->closure) || !is_array($this->closure)) ? [] : $this->closure;
146            $this->closure = new Collection\ClosureList($this->closure);
147            foreach ($this->closure as $key => $closure) {
148                if (!$closure instanceof Closure) {
149                    $this->closure[$key] = new Closure($closure);
150                }
151            }
152        }
153        return $this->closure;
154    }
155
156    public function getRequestList()
157    {
158        return $this->getProvider()->getRequestList();
159    }
160
161    public function getPreference($preferenceKey, $index, $isBool = false, $default = null)
162    {
163        $preference = $this->toProperty()->preferences->$preferenceKey->$index->get($default);
164        return ($isBool) ? ($preference ? 1 : 0) : $preference;
165    }
166
167    public function getStatus($statusKey, $index)
168    {
169        return $this->toProperty()->status->$statusKey->$index->get();
170    }
171
172    public function getContactEmail()
173    {
174        return $this->toProperty()->contact->email->get();
175    }
176
177    public function getName()
178    {
179        return $this->toProperty()->contact->name->get();
180    }
181
182    public function getScopeInfo()
183    {
184        return $this->toProperty()->preferences->ticketprinter->buttonName->get();
185    }
186
187    public function getScopeHint()
188    {
189        return $this->toProperty()->hint->get();
190    }
191
192    public function getDisplayNumberPrefix()
193    {
194        return $this->toProperty()->preferences->queue->displayNumberPrefix->get();
195    }
196
197    public function getAlternateRedirectUrl()
198    {
199        $alternateUrl = $this->toProperty()->preferences->client->alternateAppointmentUrl->get();
200
201        return ($alternateUrl) ? $alternateUrl : null;
202    }
203
204    public function getAppointmentsPerMail()
205    {
206        $appointmentsPerMail = $this->toProperty()->preferences->client->appointmentsPerMail->get();
207
208        return ($appointmentsPerMail) ? $appointmentsPerMail : null;
209    }
210
211    public function getSlotsPerAppointment()
212    {
213        $slotsPerAppointment = $this->toProperty()->preferences->client->slotsPerAppointment->get();
214
215        return ($slotsPerAppointment) ? $slotsPerAppointment : null;
216    }
217
218    public function getWhitelistedMails()
219    {
220        $emails = $this->toProperty()->preferences->client->whitelistedMails->get();
221
222        return ($emails) ? $emails : '';
223    }
224
225    public function getReservationDuration()
226    {
227        return $this->toProperty()->preferences->appointment->reservationDuration->get();
228    }
229
230    public function getWaitingTimeFromQueueList(Collection\QueueList $queueList, \DateTimeInterface $dateTime)
231    {
232        return $queueList->getEstimatedWaitingTime(
233            $this->getPreference('queue', 'processingTimeAverage'),
234            $this->getCalculatedWorkstationCount(),
235            $dateTime
236        );
237    }
238
239    public function getCalculatedWorkstationCount()
240    {
241        $workstationCount = null;
242        if ($this->getStatus('queue', 'workstationCount') > 0) {
243            $workstationCount = $this->getStatus('queue', 'workstationCount');
244        } elseif (! $workstationCount && $this->getStatus('queue', 'ghostWorkstationCount') > 0) {
245            $workstationCount = $this->getStatus('queue', 'ghostWorkstationCount');
246        }
247        return $workstationCount;
248    }
249
250    /**
251    * Get last bookable start date of a scope
252    *
253    * @return \DateTimeImmutable $scopeEndDate
254    */
255    public function getBookableStartDate(\DateTimeInterface $now)
256    {
257        $now = Helper\DateTime::create($now);
258        $scopeStartDate = $this->toProperty()->preferences->appointment->startInDaysDefault->get();
259        return ($scopeStartDate) ? $now->modify('+' . $scopeStartDate . 'days') : $now;
260    }
261
262    /**
263    * Get last bookable end date of a scope
264    *
265    * @return \DateTimeImmutable $scopeEndDate
266    */
267    public function getBookableEndDate(\DateTimeInterface $now)
268    {
269        $now = Helper\DateTime::create($now);
270        $scopeEndDate = $this->toProperty()->preferences->appointment->endInDaysDefault->get();
271        return ($scopeEndDate) ? $now->modify('+' . $scopeEndDate . 'days') : $now;
272    }
273
274    public function updateStatusQueue(\DateTimeInterface $dateTime)
275    {
276        $lastQueueUpdateDate = Helper\DateTime::create()
277            ->setTimestamp($this->getStatus('queue', 'lastGivenNumberTimestamp'));
278        if ($lastQueueUpdateDate->format('Y-m-d') == $dateTime->format('Y-m-d')) {
279            $this->setStatusQueue('lastGivenNumber', $this->getStatus('queue', 'lastGivenNumber') + 1);
280            $this->setStatusQueue('givenNumberCount', $this->getStatus('queue', 'givenNumberCount') + 1);
281        } else {
282            $this->setStatusQueue('lastGivenNumber', $this->getPreference('queue', 'firstNumber'));
283            $this->setStatusQueue('givenNumberCount', 1);
284        }
285        if ($this->getStatus('queue', 'lastGivenNumber') < $this->getPreference('queue', 'firstNumber')) {
286            $this->setStatusQueue('lastGivenNumber', $this->getPreference('queue', 'firstNumber'));
287        } elseif ($this->getStatus('queue', 'lastGivenNumber') > $this->getPreference('queue', 'lastNumber')) {
288            $this->setStatusQueue('lastGivenNumber', $this->getPreference('queue', 'firstNumber'));
289        }
290        $this->setStatusQueue('lastGivenNumberTimestamp', $dateTime->getTimestamp());
291        return $this;
292    }
293
294    public function incrementDisplayNumber()
295    {
296        if ($this->getStatus('queue', 'lastDisplayNumber') >= $this->getStatus('queue', 'maxDisplayNumber')) {
297            $this->setStatusQueue('lastDisplayNumber', 1);
298            return $this;
299        }
300
301        $this->setStatusQueue('lastDisplayNumber', $this->getStatus('queue', 'lastDisplayNumber') + 1);
302        return $this;
303    }
304
305    public function hasEmailFrom()
306    {
307        $emailFrom = $this->getPreference('client', 'emailFrom');
308        return ($emailFrom) ? true : false;
309    }
310
311    public function isEmailRequired()
312    {
313        $emailFrom = $this->getPreference('client', 'emailFrom');
314        $emailRequired = $this->getPreference('client', 'emailRequired');
315        return ($emailFrom && $emailRequired) ? true : false;
316    }
317
318    public function isTelephoneRequired()
319    {
320        $telephoneRequired = $this->getPreference('client', 'telephoneRequired');
321        return $telephoneRequired ? true : false;
322    }
323
324    #[\Override]
325    public function hasAccess(Useraccount $useraccount)
326    {
327        return $useraccount->hasRights(['superuser']) ||  $useraccount->hasScope($this->id);
328    }
329
330    /**
331     * Reduce data of dereferenced entities to a required minimum
332     *
333     */
334    #[\Override]
335    public function withLessData(array $keepArray = [])
336    {
337        $entity = clone $this;
338        if (! in_array('dayoff', $keepArray) && $entity->toProperty()->dayoff->isAvailable()) {
339            unset($entity['dayoff']);
340        }
341        if (! in_array('status', $keepArray)) {
342            unset($entity['status']);
343        }
344        if (! in_array('preferences', $keepArray)) {
345            unset($entity['preferences']);
346        }
347
348        return $entity;
349    }
350
351    public function setStatusQueue($key, $value)
352    {
353        $this->status['queue'][$key] = $value;
354        return $this;
355    }
356
357    public function setStatusAvailability($key, $value)
358    {
359        $this->status['availability'][$key] = $value;
360        return $this;
361    }
362
363    /**
364     * Check if scope is newer than given time
365     *
366     * @return bool
367     */
368    public function isNewerThan(\DateTimeInterface $dateTime)
369    {
370        return ($dateTime->getTimestamp() < $this->lastChange);
371    }
372
373    public function __toString()
374    {
375        $string = 'scope#';
376        $string .= $this['id'];
377        $string .= ' ';
378        $string .= $this->getName();
379        return $string;
380    }
381}