WCF/wcfsetup/install/files/lib/system/gridView/admin/LabelGridView.class.php at 46bbcbcbfe7b078a71f43de27b1f099cdcfd50ff · WoltLab/WCF · GitHub

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
<?php

namespace wcf\system\gridView\admin;

use wcf\acp\form\LabelEditForm;
use wcf\data\DatabaseObject;
use wcf\data\label\group\LabelGroupList;
use wcf\data\label\group\ViewableLabelGroup;
use wcf\data\label\I18nLabelList;
use wcf\data\label\Label;
use wcf\event\gridView\admin\LabelGridViewInitialized;
use wcf\system\cache\builder\LabelCacheBuilder;
use wcf\system\gridView\AbstractGridView;
use wcf\system\gridView\GridViewColumn;
use wcf\system\gridView\GridViewRowLink;
use wcf\system\gridView\renderer\AbstractColumnRenderer;
use wcf\system\gridView\renderer\NumberColumnRenderer;
use wcf\system\gridView\renderer\ObjectIdColumnRenderer;
use wcf\system\interaction\admin\LabelInteractions;
use wcf\system\interaction\bulk\admin\LabelBulkInteractions;
use wcf\system\interaction\Divider;
use wcf\system\interaction\EditInteraction;
use wcf\system\view\filter\I18nTextFilter;
use wcf\system\view\filter\IntegerFilter;
use wcf\system\view\filter\SelectFilter;
use wcf\system\WCF;
use wcf\util\StringUtil;

/**
 * Grid view for the list of labels.
 *
 * @author Olaf Braun
 * @copyright 2001-2025 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @since 6.2
 *
 * @extends AbstractGridView<Label, I18nLabelList>
 */
final class LabelGridView extends AbstractGridView
{
    public function __construct()
    {
        $this->addColumns([
            GridViewColumn::for("labelID")
                ->label("wcf.global.objectID")
                ->renderer(new ObjectIdColumnRenderer())
                ->sortable(),
            GridViewColumn::for("label")
                ->label("wcf.acp.label.label")
                ->titleColumn()
                ->filter(I18nTextFilter::class)
                ->renderer(
                    new class extends AbstractColumnRenderer {
                        #[\Override]
                        public function render(mixed $value, DatabaseObject $row): string
                        {
                            \assert($row instanceof Label);
                            $badgeClassName = StringUtil::encodeHTML($row->getClassNames());
                            $label = StringUtil::encodeHTML($row->getTitle());

                            return <<<HTML
                                <span class="badge label {$badgeClassName}">{$label}</span>
                            HTML;
                        }
                    }
                )
                ->sortable(sortByDatabaseColumn: "labelI18n"),
            GridViewColumn::for("groupID")
                ->label("wcf.acp.label.group")
                ->renderer(
                    new class extends AbstractColumnRenderer {
                        #[\Override]
                        public function render(mixed $value, DatabaseObject $row): string
                        {
                            \assert($row instanceof Label);

                            $groups = LabelCacheBuilder::getInstance()->getData(arrayIndex: "groups");
                            $group = $groups[$row->groupID];
                            \assert($group instanceof ViewableLabelGroup);

                            return StringUtil::encodeHTML($group->getExtendedTitle());
                        }
                    }
                )
                ->filter(
                    new SelectFilter(
                        $this->getAvailableLabelGroups(),
                        'groupID',
                        'wcf.acp.label.group',
                        labelLanguageItems: false
                    )
                )
                ->sortable(),
            GridViewColumn::for("showOrder")
                ->label("wcf.global.showOrder")
                ->renderer(new NumberColumnRenderer())
                ->filter(IntegerFilter::class)
                ->sortable(),
        ]);

        $provider = new LabelInteractions();
        $provider->addInteractions([
            new Divider(),
            new EditInteraction(LabelEditForm::class),
        ]);
        $this->setInteractionProvider($provider);
        $this->setBulkInteractionProvider(new LabelBulkInteractions());

        $this->setDefaultSortField("label");
        $this->addRowLink(new GridViewRowLink(LabelEditForm::class));
    }

    #[\Override]
    public function isAccessible(): bool
    {
        return WCF::getSession()->getPermission("admin.content.label.canManageLabel");
    }

    #[\Override]
    protected function createObjectList(): I18nLabelList
    {
        return new I18nLabelList();
    }

    #[\Override]
    protected function getInitializedEvent(): LabelGridViewInitialized
    {
        return new LabelGridViewInitialized($this);
    }

    /**
     * @return array<int, string>
     */
    protected function getAvailableLabelGroups(): array
    {
        $labelGroupList = new LabelGroupList();
        $labelGroupList->readObjects();
        $labelGroups = \array_map(static fn($group) => $group->getExtendedTitle(), $labelGroupList->getObjects());

        $collator = new \Collator(WCF::getLanguage()->getLocale());
        \uasort(
            $labelGroups,
            static fn(string $groupA, string $groupB) => $collator->compare($groupA, $groupB)
        );

        return $labelGroups;
    }
}