ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
Glyph.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
27
28interface Glyph extends Symbol, Clickable
29{
30 // Types of glyphs:
31 public const SETTINGS = "settings";
32 public const EXPAND = "expand";
33 public const COLLAPSE = "collapse";
34 public const COLLAPSE_HORIZONTAL = "collapsehorizontal";
35 public const ADD = "add";
36 public const REMOVE = "remove";
37 public const UP = "up";
38 public const DOWN = "down";
39 public const BACK = "back";
40 public const NEXT = "next";
41 public const SORT_ASCENDING = "sortAscending";
42 public const SORT_DESCENDING = "sortDescending";
43 public const USER = "user";
44 public const MAIL = "mail";
45 public const NOTIFICATION = "notification";
46 public const TAG = "tag";
47 public const NOTE = "note";
48 public const COMMENT = "comment";
49 public const BRIEFCASE = "briefcase";
50 public const LIKE = "like";
51 public const LOVE = "love";
52 public const DISLIKE = "dislike";
53 public const LAUGH = "laugh";
54 public const ASTOUNDED = "astounded";
55 public const SAD = "sad";
56 public const ANGRY = "angry";
57 public const EYEOPEN = "eyeopen";
58 public const EYECLOSED = "eyeclosed";
59 public const ATTACHMENT = "attachment";
60 public const RESET = "reset";
61 public const APPLY = "apply";
62 public const SEARCH = "search";
63 public const HELP = "help";
64 public const CALENDAR = "calendar";
65 public const TIME = "time";
66 public const CLOSE = "close";
67 public const MORE = "more";
68 public const DISCLOSURE = "disclosure";
69 public const LANGUAGE = "language";
70 public const LOGIN = "login";
71 public const LOGOUT = "logout";
72 public const BULLETLIST = "bulletlist";
73 public const NUMBEREDLIST = "numberedlist";
74 public const LISTINDENT = "listindent";
75 public const LISTOUTDENT = "listoutdent";
76 public const FILTER = "filter";
77 public const HEADER = "header";
78 public const BOLD = "bold";
79 public const ITALIC = "italic";
80 public const LINK = "link";
81 public const LAUNCH = "launch";
82 public const ENLARGE = "enlarge";
83 public const LIST_VIEW = "listView";
84 public const PREVIEW = "preview";
85 public const SORT = "sort";
86 public const COLUMN_SELECTION = "columnSelection";
87 public const TILE_VIEW = "tileView";
88 public const DRAG_HANDLE = "dragHandle";
89 public const CHECKED = "checked";
90 public const UNCHECKED = "unchecked";
91
95 public function getType(): string;
96
101 public function getAction(): ?string;
102
108 public function getCounters(): array;
109
117
121 public function isHighlighted(): bool;
122
126 public function withHighlight(): Glyph;
127
132 public function isActive(): bool;
133
141 public function withUnavailableAction(): Glyph;
142
147 public function withAction(string $action): Glyph;
148
150 public function withOnClick(Signal $signal);
151
153 public function appendOnClick(Signal $signal);
154
156 public function withResetTriggeredSignals();
157
159 public function getTriggeredSignals(): array;
160
162 public function withOnLoadCode(\Closure $binder);
163
165 public function withAdditionalOnLoadCode(\Closure $binder);
166
168 public function getOnLoadCode(): ?\Closure;
169}
This tags a counter object.
Definition: Counter.php:29
isActive()
Get to know if the glyph is activated.
getAction()
Get the action on the glyph.
withAdditionalOnLoadCode(\Closure $binder)
withAction(string $action)
Get a Glyph like this with an action.
withUnavailableAction()
Get a glyph like this, but action should be unavailable atm.
withHighlight()
Get a Glyph like this with a highlight.
getCounters()
Get all counters attached to this glyph.
withCounter(Counter $counter)
Get a glyph like this, but with a counter on it.
getType()
Get the type of the glyph.
isHighlighted()
Returns whether the Glyph is highlighted.
This describes a symbol.
Definition: Symbol.php:30
$counter