ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
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
7use \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 SORT = "sort";
28 const USER = "user";
29 const MAIL = "mail";
30 const NOTIFICATION = "notification";
31 const TAG = "tag";
32 const NOTE = "note";
33 const COMMENT = "comment";
34 const BRIEFCASE = "briefcase";
35 const LIKE = "like";
36 const LOVE = "love";
37 const DISLIKE = "dislike";
38 const LAUGH = "laugh";
39 const ASTOUNDED = "astounded";
40 const SAD = "sad";
41 const ANGRY = "angry";
42 const EYEOPEN = "eyeopen";
43 const EYECLOSED = "eyeclosed";
44 const ATTACHMENT = "attachment";
45 const RESET = "reset";
46 const APPLY = "apply";
47
48
54 public function getType();
55
61 public function getAction();
62
68 public function getCounters();
69
79 public function withCounter(Counter $counter);
80
81
87 public function isHighlighted();
88
95 public function withHighlight();
96
102 public function isActive();
103
112 public function withUnavailableAction();
113}
An exception for terminatinating execution or to throw for unit testing.
A component is the most general form of an entity in the UI.
Definition: Component.php:14
This tags a counter object.
Definition: Counter.php:11
This describes how a glyph could be modified during construction of UI.
Definition: Glyph.php:14
withCounter(Counter $counter)
Get a glyph like this, but with a counter on it.
getAction()
Get the action on the glyph.
getType()
Get the type of the glyph.
withHighlight()
Get a Glyph like this with a highlight.
isActive()
Get to know if the glyph is activated.
withUnavailableAction()
Get a glyph like this, but action should be unavailable atm.
getCounters()
Get all counters attached to this glyph.
isHighlighted()
Returns whether the Glyph is highlighted.
Interface to be extended by components that have the possibility to bind to Javascript.