From e694b30a4f1e1cce6cbca0fcbbfeceee8a16c8f6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julius=20H=C3=A4rtl?= <jus@bitgrid.net>
Date: Thu, 15 Feb 2018 10:38:25 +0100
Subject: [PATCH] Update phpDoc comments and add more type hinting
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Signed-off-by: Julius Härtl <jus@bitgrid.net>
---
lib/private/NavigationManager.php | 13 +++++++------
lib/public/INavigationManager.php | 2 +-
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/lib/private/NavigationManager.php b/lib/private/NavigationManager.php
index 8d62ebc8ed8..279c899c5fa 100644
--- a/lib/private/NavigationManager.php
+++ b/lib/private/NavigationManager.php
@@ -104,9 +104,10 @@ class NavigationManager implements INavigationManager {
}
/**
- * returns all the added Menu entries
- * @param string $type
- * @return array an array of the added entries
+ * Get a list of navigation entries
+ *
+ * @param string $type type of the navigation entries
+ * @return array
*/
public function getAll(string $type = 'link'): array {
$this->init();
@@ -128,10 +129,10 @@ class NavigationManager implements INavigationManager {
/**
* Sort navigation entries by order, name and set active flag
*
- * @param $list
- * @return mixed
+ * @param array $list
+ * @return array
*/
- private function proceedNavigation($list) {
+ private function proceedNavigation(array $list): array {
usort($list, function($a, $b) {
if (isset($a['order']) && isset($b['order'])) {
return ($a['order'] < $b['order']) ? -1 : 1;
diff --git a/lib/public/INavigationManager.php b/lib/public/INavigationManager.php
index 344ea47e2e0..77b881b8b15 100644
--- a/lib/public/INavigationManager.php
+++ b/lib/public/INavigationManager.php
@@ -61,7 +61,7 @@ interface INavigationManager {
/**
* Get a list of navigation entries
*
- * @param bool $absolute set to true if links to navigation entries should be converted to absolute urls
+ * @param string $type type of the navigation entries
* @return array
* @since 14.0.0
*/
--
GitLab