ILIAS  release_7 Revision v7.30-3-g800a261c036
All Data Structures Namespaces Files Functions Variables Modules Pages
Glyph.php
Go to the documentation of this file.
1 <?php
2 
3 /* Copyright (c) 2015 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */
4 
6 
7 use \ILIAS\UI\Component\Counter\Counter;
9 
14 {
15  // Types of glyphs:
16  public const SETTINGS = "settings";
17  public const EXPAND = "expand";
18  public const COLLAPSE = "collapse";
19  public const ADD = "add";
20  public const REMOVE = "remove";
21  public const UP = "up";
22  public const DOWN = "down";
23  public const BACK = "back";
24  public const NEXT = "next";
25  public const SORT_ASCENDING = "sortAscending";
26  public const SORT_DESCENDING = "sortDescending";
27  public const USER = "user";
28  public const MAIL = "mail";
29  public const NOTIFICATION = "notification";
30  public const TAG = "tag";
31  public const NOTE = "note";
32  public const COMMENT = "comment";
33  public const BRIEFCASE = "briefcase";
34  public const LIKE = "like";
35  public const LOVE = "love";
36  public const DISLIKE = "dislike";
37  public const LAUGH = "laugh";
38  public const ASTOUNDED = "astounded";
39  public const SAD = "sad";
40  public const ANGRY = "angry";
41  public const EYEOPEN = "eyeopen";
42  public const EYECLOSED = "eyeclosed";
43  public const ATTACHMENT = "attachment";
44  public const RESET = "reset";
45  public const APPLY = "apply";
46  public const SEARCH = "search";
47  public const HELP = "help";
48  public const CALENDAR = "calendar";
49  public const TIME = "time";
50  public const CLOSE = "close";
51  public const MORE = "more";
52  public const DISCLOSURE = "disclosure";
53  public const LANGUAGE = "language";
54  public const LOGIN = "login";
55  public const LOGOUT = "logout";
56  public const BULLETLIST = "bulletlist";
57  public const NUMBEREDLIST = "numberedlist";
58  public const LISTINDENT = "listindent";
59  public const LISTOUTDENT = "listoutdent";
60  public const FILTER = "filter";
61 
67  public function getType();
68 
74  public function getAction();
75 
81  public function getCounters();
82 
92  public function withCounter(Counter $counter);
93 
94 
100  public function isHighlighted();
101 
108  public function withHighlight();
109 
115  public function isActive();
116 
125  public function withUnavailableAction();
126 
133  public function withAction($action);
134 }
getAction()
Get the action on the glyph.
withAction($action)
Get a Glyph like this with an action.
This tags a counter object.
Definition: Counter.php:10
This describes a symbol.
Definition: Symbol.php:11
isHighlighted()
Returns whether the Glyph is highlighted.
withUnavailableAction()
Get a glyph like this, but action should be unavailable atm.
This describes how a glyph could be modified during construction of UI.
Definition: Glyph.php:13
withCounter(Counter $counter)
Get a glyph like this, but with a counter on it.
getType()
Get the type of the glyph.
getCounters()
Get all counters attached to this glyph.
isActive()
Get to know if the glyph is activated.
withHighlight()
Get a Glyph like this with a highlight.