ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
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
36
42 public function getType();
43
49 public function getAction();
50
56 public function getCounters();
57
67 public function withCounter(Counter $counter);
68
69
75 public function isHighlighted();
76
83 public function withHighlight();
84}
An exception for terminatinating execution or to throw for unit testing.
$counter
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.
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.