ILIAS  release_8 Revision v8.24
Glyph.php
Go to the documentation of this file.
1<?php
2
19declare(strict_types=1);
20
22
26
30interface Glyph extends Symbol, Clickable
31{
32 // Types of glyphs:
33 public const SETTINGS = "settings";
34 public const EXPAND = "expand";
35 public const COLLAPSE = "collapse";
36 public const COLLAPSE_HORIZONTAL = "collapsehorizontal";
37 public const ADD = "add";
38 public const REMOVE = "remove";
39 public const UP = "up";
40 public const DOWN = "down";
41 public const BACK = "back";
42 public const NEXT = "next";
43 public const SORT_ASCENDING = "sortAscending";
44 public const SORT_DESCENDING = "sortDescending";
45 public const USER = "user";
46 public const MAIL = "mail";
47 public const NOTIFICATION = "notification";
48 public const TAG = "tag";
49 public const NOTE = "note";
50 public const COMMENT = "comment";
51 public const BRIEFCASE = "briefcase";
52 public const LIKE = "like";
53 public const LOVE = "love";
54 public const DISLIKE = "dislike";
55 public const LAUGH = "laugh";
56 public const ASTOUNDED = "astounded";
57 public const SAD = "sad";
58 public const ANGRY = "angry";
59 public const EYEOPEN = "eyeopen";
60 public const EYECLOSED = "eyeclosed";
61 public const ATTACHMENT = "attachment";
62 public const RESET = "reset";
63 public const APPLY = "apply";
64 public const SEARCH = "search";
65 public const HELP = "help";
66 public const CALENDAR = "calendar";
67 public const TIME = "time";
68 public const CLOSE = "close";
69 public const MORE = "more";
70 public const DISCLOSURE = "disclosure";
71 public const LANGUAGE = "language";
72 public const LOGIN = "login";
73 public const LOGOUT = "logout";
74 public const BULLETLIST = "bulletlist";
75 public const NUMBEREDLIST = "numberedlist";
76 public const LISTINDENT = "listindent";
77 public const LISTOUTDENT = "listoutdent";
78 public const FILTER = "filter";
79
83 public function getType(): string;
84
88 public function getAction(): ?string;
89
95 public function getCounters(): array;
96
103 public function withCounter(Counter $counter): Glyph;
104
108 public function isHighlighted(): bool;
109
113 public function withHighlight(): Glyph;
114
118 public function isActive(): bool;
119
126 public function withUnavailableAction(): Glyph;
127
131 public function withAction(string $action): Glyph;
132}
This tags a counter object.
Definition: Counter.php:29
This describes how a glyph could be modified during construction of UI.
Definition: Glyph.php:31
isActive()
Get to know if the glyph is activated.
getAction()
Get the action on the glyph.
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
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: Factory.php:21