We could not synchronize checks via GitHub's checks API since Scrutinizer's GitHub App is not installed for this repository.
1 | <?php |
||
2 | |||
3 | /** |
||
4 | * (c) Kitodo. Key to digital objects e.V. <[email protected]> |
||
5 | * |
||
6 | * This file is part of the Kitodo and TYPO3 projects. |
||
7 | * |
||
8 | * @license GNU General Public License version 3 or later. |
||
9 | * For the full copyright and license information, please read the |
||
10 | * LICENSE.txt file that was distributed with this source code. |
||
11 | */ |
||
12 | |||
13 | namespace Kitodo\Dlf\Domain\Model; |
||
14 | |||
15 | use Kitodo\Dlf\Common\AbstractDocument; |
||
16 | use TYPO3\CMS\Extbase\Annotation as Extbase; |
||
17 | use TYPO3\CMS\Extbase\DomainObject\AbstractEntity; |
||
18 | use TYPO3\CMS\Extbase\Persistence\Generic\LazyLoadingProxy; |
||
19 | use TYPO3\CMS\Extbase\Persistence\ObjectStorage; |
||
20 | |||
21 | /** |
||
22 | * Domain model of the 'Document'. |
||
23 | * |
||
24 | * @package TYPO3 |
||
25 | * @subpackage dlf |
||
26 | * |
||
27 | * @access public |
||
28 | */ |
||
29 | class Document extends AbstractEntity |
||
30 | { |
||
31 | /** |
||
32 | * @access protected |
||
33 | * @var \DateTime |
||
34 | */ |
||
35 | protected $crdate; |
||
36 | |||
37 | /** |
||
38 | * @access protected |
||
39 | * @var \DateTime |
||
40 | */ |
||
41 | protected $tstamp; |
||
42 | |||
43 | /** |
||
44 | * @access protected |
||
45 | * @var AbstractDocument|null This contains the representative of the raw XML / IIIF data of the document. |
||
46 | */ |
||
47 | protected $currentDocument = null; |
||
48 | |||
49 | /** |
||
50 | * @access protected |
||
51 | * @var string |
||
52 | */ |
||
53 | protected $title; |
||
54 | |||
55 | /** |
||
56 | * @access protected |
||
57 | * @var string |
||
58 | */ |
||
59 | protected $prodId; |
||
60 | |||
61 | /** |
||
62 | * @access protected |
||
63 | * @var string |
||
64 | */ |
||
65 | protected $location; |
||
66 | |||
67 | /** |
||
68 | * @access protected |
||
69 | * @var string |
||
70 | */ |
||
71 | protected $recordId; |
||
72 | |||
73 | /** |
||
74 | * @access protected |
||
75 | * @var string |
||
76 | */ |
||
77 | protected $opacId; |
||
78 | |||
79 | /** |
||
80 | * @access protected |
||
81 | * @var string |
||
82 | */ |
||
83 | protected $unionId; |
||
84 | |||
85 | /** |
||
86 | * @access protected |
||
87 | * @var string |
||
88 | */ |
||
89 | protected $urn; |
||
90 | |||
91 | /** |
||
92 | * @access protected |
||
93 | * @var string |
||
94 | */ |
||
95 | protected $purl; |
||
96 | |||
97 | /** |
||
98 | * @access protected |
||
99 | * @var string |
||
100 | */ |
||
101 | protected $titleSorting; |
||
102 | |||
103 | /** |
||
104 | * @access protected |
||
105 | * @var string |
||
106 | */ |
||
107 | protected $author; |
||
108 | |||
109 | /** |
||
110 | * @access protected |
||
111 | * @var string |
||
112 | */ |
||
113 | protected $year; |
||
114 | |||
115 | /** |
||
116 | * @access protected |
||
117 | * @var string |
||
118 | */ |
||
119 | protected $place; |
||
120 | |||
121 | /** |
||
122 | * @access protected |
||
123 | * @var string |
||
124 | */ |
||
125 | protected $thumbnail; |
||
126 | |||
127 | /** |
||
128 | * @access protected |
||
129 | * @var Structure |
||
130 | */ |
||
131 | protected $structure; |
||
132 | |||
133 | /** |
||
134 | * @access protected |
||
135 | * @var int |
||
136 | */ |
||
137 | protected $partof = 0; |
||
138 | |||
139 | /** |
||
140 | * @access protected |
||
141 | * @var string |
||
142 | */ |
||
143 | protected $volume; |
||
144 | |||
145 | /** |
||
146 | * @access protected |
||
147 | * @var string |
||
148 | */ |
||
149 | protected $volumeSorting; |
||
150 | |||
151 | /** |
||
152 | * @access protected |
||
153 | * @var string |
||
154 | */ |
||
155 | protected $license; |
||
156 | |||
157 | /** |
||
158 | * @access protected |
||
159 | * @var string |
||
160 | */ |
||
161 | protected $terms; |
||
162 | |||
163 | /** |
||
164 | * @access protected |
||
165 | * @var string |
||
166 | */ |
||
167 | protected $restrictions; |
||
168 | |||
169 | /** |
||
170 | * @access protected |
||
171 | * @var string |
||
172 | */ |
||
173 | protected $outOfPrint; |
||
174 | |||
175 | /** |
||
176 | * @access protected |
||
177 | * @var string |
||
178 | */ |
||
179 | protected $rightsInfo; |
||
180 | |||
181 | /** |
||
182 | * @access protected |
||
183 | * @var ObjectStorage<Collection> |
||
184 | * @Extbase\ORM\Lazy |
||
185 | */ |
||
186 | protected $collections = null; |
||
187 | |||
188 | /** |
||
189 | * @access protected |
||
190 | * @var string |
||
191 | */ |
||
192 | protected $metsLabel; |
||
193 | |||
194 | /** |
||
195 | * @access protected |
||
196 | * @var string |
||
197 | */ |
||
198 | protected $metsOrderlabel; |
||
199 | |||
200 | /** |
||
201 | * @access protected |
||
202 | * @var Library |
||
203 | * @Extbase\ORM\Lazy |
||
204 | */ |
||
205 | protected $owner; |
||
206 | |||
207 | /** |
||
208 | * @access protected |
||
209 | * @var int |
||
210 | */ |
||
211 | protected $solrcore; |
||
212 | |||
213 | /** |
||
214 | * @access protected |
||
215 | * @var int |
||
216 | */ |
||
217 | protected $status; |
||
218 | |||
219 | /** |
||
220 | * @access protected |
||
221 | * @var string |
||
222 | */ |
||
223 | protected $documentFormat; |
||
224 | |||
225 | /** |
||
226 | * constructor |
||
227 | */ |
||
228 | public function __construct() |
||
229 | { |
||
230 | // Do not remove the next line: It would break the functionality |
||
231 | $this->initStorageObjects(); |
||
232 | } |
||
233 | |||
234 | protected function initStorageObjects() |
||
235 | { |
||
236 | $this->collections = new ObjectStorage(); |
||
237 | } |
||
238 | |||
239 | /** |
||
240 | * @return AbstractDocument |
||
241 | */ |
||
242 | public function getCurrentDocument(): ?AbstractDocument |
||
243 | { |
||
244 | return $this->currentDocument; |
||
245 | } |
||
246 | |||
247 | /** |
||
248 | * @param AbstractDocument $currentDocument |
||
249 | */ |
||
250 | public function setCurrentDocument(AbstractDocument $currentDocument): void |
||
251 | { |
||
252 | $this->currentDocument = $currentDocument; |
||
253 | } |
||
254 | |||
255 | /** |
||
256 | * @return string |
||
257 | */ |
||
258 | public function getTitle(): string |
||
259 | { |
||
260 | return $this->title; |
||
261 | } |
||
262 | |||
263 | /** |
||
264 | * @param string $title |
||
265 | */ |
||
266 | public function setTitle(string $title): void |
||
267 | { |
||
268 | $this->title = $title; |
||
269 | } |
||
270 | |||
271 | /** |
||
272 | * @return string |
||
273 | */ |
||
274 | public function getProdId(): string |
||
275 | { |
||
276 | return $this->prodId; |
||
277 | } |
||
278 | |||
279 | /** |
||
280 | * @param string $prodId |
||
281 | */ |
||
282 | public function setProdId(string $prodId): void |
||
283 | { |
||
284 | $this->prodId = $prodId; |
||
285 | } |
||
286 | |||
287 | /** |
||
288 | * @return string |
||
289 | */ |
||
290 | public function getLocation(): string |
||
291 | { |
||
292 | return $this->location; |
||
293 | } |
||
294 | |||
295 | /** |
||
296 | * @param string $location |
||
297 | */ |
||
298 | public function setLocation(string $location): void |
||
299 | { |
||
300 | $this->location = $location; |
||
301 | } |
||
302 | |||
303 | /** |
||
304 | * @return string |
||
305 | */ |
||
306 | public function getRecordId(): string |
||
307 | { |
||
308 | return $this->recordId; |
||
309 | } |
||
310 | |||
311 | /** |
||
312 | * @param string $recordId |
||
313 | */ |
||
314 | public function setRecordId(string $recordId): void |
||
315 | { |
||
316 | $this->recordId = $recordId; |
||
317 | } |
||
318 | |||
319 | /** |
||
320 | * @return string |
||
321 | */ |
||
322 | public function getOpacId(): string |
||
323 | { |
||
324 | return $this->opacId; |
||
325 | } |
||
326 | |||
327 | /** |
||
328 | * @param string $opacId |
||
329 | */ |
||
330 | public function setOpacId(string $opacId): void |
||
331 | { |
||
332 | $this->opacId = $opacId; |
||
333 | } |
||
334 | |||
335 | /** |
||
336 | * @return string |
||
337 | */ |
||
338 | public function getUnionId(): string |
||
339 | { |
||
340 | return $this->unionId; |
||
341 | } |
||
342 | |||
343 | /** |
||
344 | * @param string $unionId |
||
345 | */ |
||
346 | public function setUnionId(string $unionId): void |
||
347 | { |
||
348 | $this->unionId = $unionId; |
||
349 | } |
||
350 | |||
351 | /** |
||
352 | * @return string |
||
353 | */ |
||
354 | public function getUrn(): string |
||
355 | { |
||
356 | return $this->urn; |
||
357 | } |
||
358 | |||
359 | /** |
||
360 | * @param string $urn |
||
361 | */ |
||
362 | public function setUrn(string $urn): void |
||
363 | { |
||
364 | $this->urn = $urn; |
||
365 | } |
||
366 | |||
367 | /** |
||
368 | * @return string |
||
369 | */ |
||
370 | public function getPurl(): string |
||
371 | { |
||
372 | return $this->purl; |
||
373 | } |
||
374 | |||
375 | /** |
||
376 | * @param string $purl |
||
377 | */ |
||
378 | public function setPurl(string $purl): void |
||
379 | { |
||
380 | $this->purl = $purl; |
||
381 | } |
||
382 | |||
383 | /** |
||
384 | * @return string |
||
385 | */ |
||
386 | public function getTitleSorting(): string |
||
387 | { |
||
388 | return $this->titleSorting; |
||
389 | } |
||
390 | |||
391 | /** |
||
392 | * @param string $titleSorting |
||
393 | */ |
||
394 | public function setTitleSorting(string $titleSorting): void |
||
395 | { |
||
396 | $this->titleSorting = $titleSorting; |
||
397 | } |
||
398 | |||
399 | /** |
||
400 | * @return string |
||
401 | */ |
||
402 | public function getAuthor(): string |
||
403 | { |
||
404 | return $this->author; |
||
405 | } |
||
406 | |||
407 | /** |
||
408 | * @param string $author |
||
409 | */ |
||
410 | public function setAuthor(string $author): void |
||
411 | { |
||
412 | $this->author = $author; |
||
413 | } |
||
414 | |||
415 | /** |
||
416 | * @return string |
||
417 | */ |
||
418 | public function getYear(): string |
||
419 | { |
||
420 | return $this->year; |
||
421 | } |
||
422 | |||
423 | /** |
||
424 | * @param string $year |
||
425 | */ |
||
426 | public function setYear(string $year): void |
||
427 | { |
||
428 | $this->year = $year; |
||
429 | } |
||
430 | |||
431 | /** |
||
432 | * @return string |
||
433 | */ |
||
434 | public function getPlace(): string |
||
435 | { |
||
436 | return $this->place; |
||
437 | } |
||
438 | |||
439 | /** |
||
440 | * @param string $place |
||
441 | */ |
||
442 | public function setPlace(string $place): void |
||
443 | { |
||
444 | $this->place = $place; |
||
445 | } |
||
446 | |||
447 | /** |
||
448 | * @return string |
||
449 | */ |
||
450 | public function getThumbnail(): string |
||
451 | { |
||
452 | return $this->thumbnail; |
||
453 | } |
||
454 | |||
455 | /** |
||
456 | * @param string $thumbnail |
||
457 | */ |
||
458 | public function setThumbnail(string $thumbnail): void |
||
459 | { |
||
460 | $this->thumbnail = $thumbnail; |
||
461 | } |
||
462 | |||
463 | /** |
||
464 | * @return Structure |
||
465 | */ |
||
466 | public function getStructure(): Structure |
||
467 | { |
||
468 | return $this->structure; |
||
469 | } |
||
470 | |||
471 | /** |
||
472 | * @param Structure $structure |
||
473 | */ |
||
474 | public function setStructure(Structure $structure): void |
||
475 | { |
||
476 | $this->structure = $structure; |
||
477 | } |
||
478 | |||
479 | /** |
||
480 | * @return int |
||
481 | */ |
||
482 | public function getPartof(): int |
||
483 | { |
||
484 | return $this->partof; |
||
485 | } |
||
486 | |||
487 | /** |
||
488 | * @param int $partof |
||
489 | */ |
||
490 | public function setPartof(int $partof): void |
||
491 | { |
||
492 | $this->partof = $partof; |
||
493 | } |
||
494 | |||
495 | /** |
||
496 | * @return string |
||
497 | */ |
||
498 | public function getVolume(): string |
||
499 | { |
||
500 | return $this->volume; |
||
501 | } |
||
502 | |||
503 | /** |
||
504 | * @param string $volume |
||
505 | */ |
||
506 | public function setVolume(string $volume): void |
||
507 | { |
||
508 | $this->volume = $volume; |
||
509 | } |
||
510 | |||
511 | /** |
||
512 | * @return string |
||
513 | */ |
||
514 | public function getVolumeSorting(): string |
||
515 | { |
||
516 | return $this->volumeSorting; |
||
517 | } |
||
518 | |||
519 | /** |
||
520 | * @param string $volumeSorting |
||
521 | */ |
||
522 | public function setVolumeSorting(string $volumeSorting): void |
||
523 | { |
||
524 | $this->volumeSorting = $volumeSorting; |
||
525 | } |
||
526 | |||
527 | /** |
||
528 | * @return string |
||
529 | */ |
||
530 | public function getLicense(): string |
||
531 | { |
||
532 | return $this->license; |
||
533 | } |
||
534 | |||
535 | /** |
||
536 | * @param string $license |
||
537 | */ |
||
538 | public function setLicense(string $license): void |
||
539 | { |
||
540 | $this->license = $license; |
||
541 | } |
||
542 | |||
543 | /** |
||
544 | * @return string |
||
545 | */ |
||
546 | public function getTerms(): string |
||
547 | { |
||
548 | return $this->terms; |
||
549 | } |
||
550 | |||
551 | /** |
||
552 | * @param string $terms |
||
553 | */ |
||
554 | public function setTerms(string $terms): void |
||
555 | { |
||
556 | $this->terms = $terms; |
||
557 | } |
||
558 | |||
559 | /** |
||
560 | * @return string |
||
561 | */ |
||
562 | public function getRestrictions(): string |
||
563 | { |
||
564 | return $this->restrictions; |
||
565 | } |
||
566 | |||
567 | /** |
||
568 | * @param string $restrictions |
||
569 | */ |
||
570 | public function setRestrictions(string $restrictions): void |
||
571 | { |
||
572 | $this->restrictions = $restrictions; |
||
573 | } |
||
574 | |||
575 | /** |
||
576 | * @return string |
||
577 | */ |
||
578 | public function getOutOfPrint(): string |
||
579 | { |
||
580 | return $this->outOfPrint; |
||
581 | } |
||
582 | |||
583 | /** |
||
584 | * @param string $outOfPrint |
||
585 | */ |
||
586 | public function setOutOfPrint(string $outOfPrint): void |
||
587 | { |
||
588 | $this->outOfPrint = $outOfPrint; |
||
589 | } |
||
590 | |||
591 | /** |
||
592 | * @return string |
||
593 | */ |
||
594 | public function getRightsInfo(): string |
||
595 | { |
||
596 | return $this->rightsInfo; |
||
597 | } |
||
598 | |||
599 | /** |
||
600 | * @param string $rightsInfo |
||
601 | */ |
||
602 | public function setRightsInfo(string $rightsInfo): void |
||
603 | { |
||
604 | $this->rightsInfo = $rightsInfo; |
||
605 | } |
||
606 | |||
607 | |||
608 | /** |
||
609 | * Returns the collections |
||
610 | * |
||
611 | * @return ObjectStorage<Collection> $collections |
||
612 | */ |
||
613 | public function getCollections() |
||
614 | { |
||
615 | return $this->collections; |
||
616 | } |
||
617 | |||
618 | /** |
||
619 | * @param ObjectStorage<Collection> $collections |
||
620 | */ |
||
621 | public function setCollections(?ObjectStorage $collections): void |
||
622 | { |
||
623 | $this->collections = $collections; |
||
624 | } |
||
625 | |||
626 | /** |
||
627 | * Adds a collection |
||
628 | * |
||
629 | * @param Collection $collection |
||
630 | */ |
||
631 | public function addCollection(Collection $collection): void |
||
632 | { |
||
633 | $this->collections->attach($collection); |
||
634 | } |
||
635 | |||
636 | /** |
||
637 | * Removes a collection |
||
638 | * |
||
639 | * @param Collection $collection |
||
640 | * |
||
641 | * @return void |
||
642 | */ |
||
643 | public function removeCollection(Collection $collection): void |
||
644 | { |
||
645 | $this->collections->detach($collection); |
||
646 | } |
||
647 | |||
648 | /** |
||
649 | * @return string |
||
650 | */ |
||
651 | public function getMetsLabel(): string |
||
652 | { |
||
653 | return $this->metsLabel; |
||
654 | } |
||
655 | |||
656 | /** |
||
657 | * @param string $metsLabel |
||
658 | */ |
||
659 | public function setMetsLabel(string $metsLabel): void |
||
660 | { |
||
661 | $this->metsLabel = $metsLabel; |
||
662 | } |
||
663 | |||
664 | /** |
||
665 | * @return string |
||
666 | */ |
||
667 | public function getMetsOrderlabel(): string |
||
668 | { |
||
669 | return $this->metsOrderlabel; |
||
670 | } |
||
671 | |||
672 | /** |
||
673 | * @param string $metsOrderlabel |
||
674 | */ |
||
675 | public function setMetsOrderlabel(string $metsOrderlabel): void |
||
676 | { |
||
677 | $this->metsOrderlabel = $metsOrderlabel; |
||
678 | } |
||
679 | |||
680 | /** |
||
681 | * @return Library|null |
||
682 | */ |
||
683 | public function getOwner(): ?Library |
||
684 | { |
||
685 | return $this->owner instanceof LazyLoadingProxy |
||
0 ignored issues
–
show
introduced
by
Loading history...
|
|||
686 | ? $this->owner->_loadRealInstance() |
||
687 | : $this->owner; |
||
688 | } |
||
689 | |||
690 | /** |
||
691 | * @param Library $owner |
||
692 | */ |
||
693 | public function setOwner(Library $owner): void |
||
694 | { |
||
695 | $this->owner = $owner; |
||
696 | } |
||
697 | |||
698 | /** |
||
699 | * @return int |
||
700 | */ |
||
701 | public function getSolrcore(): int |
||
702 | { |
||
703 | return $this->solrcore; |
||
704 | } |
||
705 | |||
706 | /** |
||
707 | * @param int $solrcore |
||
708 | */ |
||
709 | public function setSolrcore(int $solrcore): void |
||
710 | { |
||
711 | $this->solrcore = $solrcore; |
||
712 | } |
||
713 | |||
714 | /** |
||
715 | * @return int |
||
716 | */ |
||
717 | public function getStatus(): int |
||
718 | { |
||
719 | return $this->status; |
||
720 | } |
||
721 | |||
722 | /** |
||
723 | * @param int $status |
||
724 | */ |
||
725 | public function setStatus(int $status): void |
||
726 | { |
||
727 | $this->status = $status; |
||
728 | } |
||
729 | |||
730 | /** |
||
731 | * @return string |
||
732 | */ |
||
733 | public function getDocumentFormat(): string |
||
734 | { |
||
735 | return $this->documentFormat; |
||
736 | } |
||
737 | |||
738 | /** |
||
739 | * @param string $documentFormat |
||
740 | */ |
||
741 | public function setDocumentFormat(string $documentFormat): void |
||
742 | { |
||
743 | $this->documentFormat = $documentFormat; |
||
744 | } |
||
745 | |||
746 | /** |
||
747 | * Returns the timestamp |
||
748 | * |
||
749 | * @return \DateTime |
||
750 | */ |
||
751 | public function getTstamp(): \DateTime |
||
752 | { |
||
753 | return $this->tstamp; |
||
754 | } |
||
755 | |||
756 | /** |
||
757 | * Sets the timestamp |
||
758 | * |
||
759 | * @param \DateTime $tstamp |
||
760 | */ |
||
761 | public function setTstamp($tstamp): void |
||
762 | { |
||
763 | $this->tstamp = $tstamp; |
||
764 | } |
||
765 | |||
766 | /** |
||
767 | * Returns the creation date |
||
768 | * |
||
769 | * @return \DateTime |
||
770 | */ |
||
771 | public function getCrdate(): \DateTime |
||
772 | { |
||
773 | return $this->crdate; |
||
774 | } |
||
775 | |||
776 | /** |
||
777 | * Sets the creation date |
||
778 | * |
||
779 | * @param \DateTime $crdate |
||
780 | */ |
||
781 | public function setCrdate($crdate): void |
||
782 | { |
||
783 | $this->crdate = $crdate; |
||
784 | } |
||
785 | |||
786 | } |
||
787 |