summaryrefslogtreecommitdiff
path: root/includes/view/UserHintsRenderer.php
diff options
context:
space:
mode:
authorBot <bot@myigel.name>2017-01-03 03:22:48 +0100
committerIgor Scheller <igor.scheller@igorshp.de>2017-01-03 03:22:48 +0100
commit356b2582f3e6a43ecf2607acad4a7fe0b37f659a (patch)
treee02c9214b23a0b9ec33aa725db962d565bd30a82 /includes/view/UserHintsRenderer.php
parentd71e7bbfad2f07f82df0c515608996d250fd4182 (diff)
PPHDoc, formatting, fixes, cleanup
Diffstat (limited to 'includes/view/UserHintsRenderer.php')
-rw-r--r--includes/view/UserHintsRenderer.php13
1 files changed, 9 insertions, 4 deletions
diff --git a/includes/view/UserHintsRenderer.php b/includes/view/UserHintsRenderer.php
index cd0f568a..aac8ecfd 100644
--- a/includes/view/UserHintsRenderer.php
+++ b/includes/view/UserHintsRenderer.php
@@ -4,12 +4,15 @@ namespace Engelsystem;
class UserHintsRenderer
{
+ /** @var string[] */
private $hints = [];
private $important = false;
/**
* Render the added hints to a popover for the toolbar.
+ *
+ * @return string
*/
public function render()
{
@@ -26,10 +29,8 @@ class UserHintsRenderer
/**
* Add a hint to the list, if its not null and a not empty string.
*
- * @param string $hint
- * The hint
- * @param boolean $important
- * Is the hint important?
+ * @param string $hint The hint
+ * @param boolean $important Is the hint important?
*/
public function addHint($hint, $important = false)
{
@@ -45,6 +46,8 @@ class UserHintsRenderer
/**
* Get all hints.
+ *
+ * @return string[]
*/
public function getHints()
{
@@ -53,6 +56,8 @@ class UserHintsRenderer
/**
* Are there important hints? This leads to a more intensive icon.
+ *
+ * @return bool
*/
public function isImportant()
{