ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
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;
8
13 // Types of glyphs:
14 const SETTINGS = "settings";
15 const EXPAND = "expand";
16 const COLLAPSE = "collapse";
17 const ADD = "add";
18 const REMOVE = "remove";
19 const UP = "up";
20 const DOWN = "down";
21 const BACK = "back";
22 const NEXT = "next";
23 const SORT_ASCENDING = "sortAscending";
24 const SORT_DESCENDING = "sortDescending";
25 const SORT = "sort";
26 const USER = "user";
27 const MAIL = "mail";
28 const NOTIFICATION = "notification";
29 const TAG = "tag";
30 const NOTE = "note";
31 const COMMENT = "comment";
32
33
39 public function getType();
40
46 public function getAction();
47
53 public function getCounters();
54
64 public function withCounter(Counter $counter);
65
66
72 public function isHighlighted();
73
80 public function withHighlight();
81}
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:13
This tags a counter object.
Definition: Counter.php:10
This describes how a glyph could be modified during construction of UI.
Definition: Glyph.php:12
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.