Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/core/Menu
diff options
context:
space:
mode:
authorsgiehl <stefangiehl@gmail.com>2012-05-24 01:19:25 +0400
committersgiehl <stefangiehl@gmail.com>2012-05-24 01:19:25 +0400
commitf419aca5cae09792f879e5570c51da699d658599 (patch)
treed67c5aa457067a17e031c44309f20292eaaa1d8d /core/Menu
parent145bd36f2bc1183442415ea3f0d2fc42970be207 (diff)
completed a bunch of php doc blocks
git-svn-id: http://dev.piwik.org/svn/trunk@6300 59fd770c-687e-43c8-a1e3-f5a4ff64c105
Diffstat (limited to 'core/Menu')
-rw-r--r--core/Menu/Abstract.php24
-rw-r--r--core/Menu/Top.php4
2 files changed, 21 insertions, 7 deletions
diff --git a/core/Menu/Abstract.php b/core/Menu/Abstract.php
index 6deabf162f..fcf12076d3 100644
--- a/core/Menu/Abstract.php
+++ b/core/Menu/Abstract.php
@@ -43,6 +43,11 @@ abstract class Piwik_Menu_Abstract
/**
* Adds a new entry to the menu.
+ * @param string $menuName
+ * @param string $subMenuName
+ * @param string $url
+ * @param bool $displayedForCurrentUser
+ * @param int $order
*/
public function add($menuName, $subMenuName, $url, $displayedForCurrentUser, $order = 50)
{
@@ -59,6 +64,10 @@ abstract class Piwik_Menu_Abstract
/**
* Builds a single menu item
+ * @param string $menuName
+ * @param string $subMenuName
+ * @param string $url
+ * @param int $order
*/
private function buildMenuItem($menuName, $subMenuName, $url, $order = 50)
{
@@ -92,7 +101,10 @@ abstract class Piwik_Menu_Abstract
/**
* Renames a single menu entry.
- *
+ * @param $mainMenuOriginal
+ * @param $subMenuOriginal
+ * @param $mainMenuRenamed
+ * @param $subMenuRenamed
*/
public function rename($mainMenuOriginal, $subMenuOriginal, $mainMenuRenamed, $subMenuRenamed)
{
@@ -102,7 +114,9 @@ abstract class Piwik_Menu_Abstract
/**
* Edits a URL of an existing menu entry.
- *
+ * @param $mainMenuToEdit
+ * @param $subMenuToEdit
+ * @param $newUrl
*/
public function editUrl($mainMenuToEdit, $subMenuToEdit, $newUrl)
{
@@ -192,9 +206,9 @@ abstract class Piwik_Menu_Abstract
/**
* Compares two menu entries. Used for ordering.
*
- * @param <array> $itemOne
- * @param <array> $itemTwo
- * @return <boolean>
+ * @param array $itemOne
+ * @param array $itemTwo
+ * @return boolean
*/
protected function menuCompare($itemOne, $itemTwo)
{
diff --git a/core/Menu/Top.php b/core/Menu/Top.php
index 1e65fdf582..66556dd1d5 100644
--- a/core/Menu/Top.php
+++ b/core/Menu/Top.php
@@ -78,10 +78,10 @@ function Piwik_GetTopMenu()
* Adds a new entry to the TopMenu.
*
* @param string $topMenuName
- * @param string $subTopName
- * @param string $url
+ * @param $data
* @param boolean $displayedForCurrentUser
* @param int $order
+ * @param bool $isHTML
*/
function Piwik_AddTopMenu( $topMenuName, $data, $displayedForCurrentUser = true, $order = 10, $isHTML = false)
{