ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
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  const SETTINGS = "settings";
17  const EXPAND = "expand";
18  const COLLAPSE = "collapse";
19  const ADD = "add";
20  const REMOVE = "remove";
21  const UP = "up";
22  const DOWN = "down";
23  const BACK = "back";
24  const NEXT = "next";
25  const SORT_ASCENDING = "sortAscending";
26  const SORT_DESCENDING = "sortDescending";
27  const USER = "user";
28  const MAIL = "mail";
29  const NOTIFICATION = "notification";
30  const TAG = "tag";
31  const NOTE = "note";
32  const COMMENT = "comment";
33  const BRIEFCASE = "briefcase";
34  const LIKE = "like";
35  const LOVE = "love";
36  const DISLIKE = "dislike";
37  const LAUGH = "laugh";
38  const ASTOUNDED = "astounded";
39  const SAD = "sad";
40  const ANGRY = "angry";
41  const EYEOPEN = "eyeopen";
42  const EYECLOSED = "eyeclosed";
43  const ATTACHMENT = "attachment";
44  const RESET = "reset";
45  const APPLY = "apply";
46  const SEARCH = "search";
47  const HELP = "help";
48  const CALENDAR = "calendar";
49  const TIME = "time";
50  const CLOSE = "close";
51  const MORE = "more";
52  const DISCLOSURE = "disclosure";
53  const LANGUAGE = "language";
54  const LOGIN = "login";
55  const LOGOUT = "logout";
56 
62  public function getType();
63 
69  public function getAction();
70 
76  public function getCounters();
77 
87  public function withCounter(Counter $counter);
88 
89 
95  public function isHighlighted();
96 
103  public function withHighlight();
104 
110  public function isActive();
111 
120  public function withUnavailableAction();
121 
128  public function withAction($action);
129 }
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.