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