aboutsummaryrefslogtreecommitdiff
path: root/lib/models/Courseware/BlockTypes/DialogCards.php
blob: 875a0b3c30dce38acc1f083bce05c8e287dbdf92 (plain)
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
<?php

namespace Courseware\BlockTypes;

/**
 * This class represents the content of a Courseware dialog cards block.
 *
 * @author  Ron Lucke <lucke@elan-ev.de>
 * @license GPL2 or any later version
 *
 * @since   Stud.IP 5.0
 */
class DialogCards extends BlockType
{
    public static function getType(): string
    {
        return 'dialog-cards';
    }

    public static function getTitle(): string
    {
        return _('Lernkarten');
    }

    public static function getDescription(): string
    {
        return _('Karten zum Umdrehen, auf beiden Seiten lässt sich ein Bild und Text darstellen.');
    }

    public function initialPayload(): array
    {
        return [
            'cards' => [['index' => 0, 'front_file_id' => '', 'front_text' => '', 'back_file_id' => '', 'back_text' => '']],
        ];
    }

    public function getPayload()
    {
        $payload = $this->decodePayloadString($this->block['payload']);

        foreach ($payload['cards'] as &$card) {
            if ($card['front_file_id']) {
                $card['front_file'] = $this->getFileById($card['front_file_id']);
                $card['front_file_ref'] = $this->getFileRefById($card['front_file_id']);
            } else {
                $card['front_file'] = [];
            }
            if ($card['back_file_id']) {
                $card['back_file'] = $this->getFileById($card['back_file_id']);
                $card['back_file_ref'] = $this->getFileRefById($card['back_file_id']);
            } else {
                $card['back_file'] = [];
            }
        }

        return $payload;
    }

    /**
     * get all files related to this block.
     *
     * @return \FileRef[] list of file references related to this block
     */
    public function getFiles(): array
    {
        $payload = $this->getPayload();
        $files = [];

        foreach ($payload['cards'] as &$card) {
            if ($card['front_file_id'] && $fileRef = \FileRef::find($card['front_file_id'])) {
                $files[] = $fileRef;
            }
            if ($card['back_file_id'] && $fileRef = \FileRef::find($card['back_file_id'])) {
                $files[] = $fileRef;
            }
        }

        return $files;
    }

    public function copyPayload(string $rangeId = ''): array
    {
        $payload = $this->getPayload();
        foreach ($payload['cards'] as &$card) {
            if ('' != $card['front_file_id']) {
                $card['front_file_id'] = $this->copyFileById($card['front_file_id'], $rangeId);
            }

            if ('' != $card['back_file_id']) {
                $card['back_file_id'] = $this->copyFileById($card['back_file_id'], $rangeId);
            }
        }

        return $payload;
    }

    public static function getJsonSchema(): string
    {
        $schemaFile = __DIR__.'/DialogCards.json';

        return file_get_contents($schemaFile);
    }

    public static function getCategories(): array
    {
        return ['interaction'];
    }

    public static function getContentTypes(): array
    {
        return ['text', 'image'];
    }

    public static function getFileTypes(): array
    {
        return ['image'];
    }

    public static function getTags(): array
    {
        return [
            _('Karteikarten'), _('Vokabeln'), _('Übersetzung'), _('übersetzen'), _('Glossar'),
            _('FAQ'), _('wenden'), _('umdrehen'), _('beidseitig'), _('Quiz'), _('Selbsttest'),
            _('Memory'), _('Lernkarten'), _('Interaktion'), _('Frage Antwort'),
            _('Lernhilfe'), _('Lerntest')
        ];
    }
}