Hide Menu Items and/or empty module - Revision history

Wayneh at 20:37, 10 January 2012

2012-01-10T20:37:26Z

@@ Line 90: / Line 90: @@
+   }
+}
 </syntaxhighlight>

Wayneh: /* Solution */

2012-01-10T20:30:35Z

Solution

← Older revision		Revision as of 20:30, 10 January 2012
Line 36:		Line 36:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

			NOTE: The 4th parameter of function menuitem is $enable as defined at http://www.ibuildings.com/docs/atk/trunk/atk/modules/atkModule.html#methodmenuitem and causes menuitem to check the user privileges. The menu item is not displayed if user does not have rights to the node/action

	This is just an example of the getMenuItems function. If you use this you should of course also have a getNodes function with the proper rights.		This is just an example of the getMenuItems function. If you use this you should of course also have a getNodes function with the proper rights.

Wayneh: /* Issue */

2012-01-10T20:24:39Z

Issue

← Older revision		Revision as of 20:24, 10 January 2012
Line 4:		Line 4:
	If you use the built-in security features for ATK you might have come accros the following scenario. If an user doesn't have rights on any of the nodes inside a module the module still appears in the main menu. This default behaviour is a little bit strange because when you click on a "empty" module you will only get the "back to Main menu" link. In this HowTo I will describe how you can hide a module from the main menu if there are no accessible nodes.		If you use the built-in security features for ATK you might have come accros the following scenario. If an user doesn't have rights on any of the nodes inside a module the module still appears in the main menu. This default behaviour is a little bit strange because when you click on a "empty" module you will only get the "back to Main menu" link. In this HowTo I will describe how you can hide a module from the main menu if there are no accessible nodes.

	~~Added examples of hiding~~ menu items for which the User does not have rights		Changed title because this also covers how to hide menu items for which the User does not have rights

	== Solution ==		== Solution ==

Wayneh: /* Issue */

2012-01-10T20:23:06Z

Issue

← Older revision		Revision as of 20:23, 10 January 2012
Line 3:		Line 3:
	== Issue ==		== Issue ==
	If you use the built-in security features for ATK you might have come accros the following scenario. If an user doesn't have rights on any of the nodes inside a module the module still appears in the main menu. This default behaviour is a little bit strange because when you click on a "empty" module you will only get the "back to Main menu" link. In this HowTo I will describe how you can hide a module from the main menu if there are no accessible nodes.		If you use the built-in security features for ATK you might have come accros the following scenario. If an user doesn't have rights on any of the nodes inside a module the module still appears in the main menu. This default behaviour is a little bit strange because when you click on a "empty" module you will only get the "back to Main menu" link. In this HowTo I will describe how you can hide a module from the main menu if there are no accessible nodes.

			Added examples of hiding menu items for which the User does not have rights

	== Solution ==		== Solution ==

Wayneh: moved Hide an empty module to Hide Menu Items and/or empty module: Examples also cover menu items

2012-01-10T20:21:41Z

moved Hide an empty module to Hide Menu Items and/or empty module: Examples also cover menu items

← Older revision	Revision as of 20:21, 10 January 2012
(No difference)

Leon: Fix destruction

2007-06-15T06:48:08Z

Fix destruction

@@ Line 47: / Line 47: @@
+   {
      // Get an instance of the security manager
-     $securityManager =</syntaxhighlight>
+     $securityManager = &atkGetSecurityManager();

Hj6Z3l at 04:30, 15 June 2007

2007-06-15T04:30:14Z

@@ Line 47: / Line 47: @@
+   {
      // Get an instance of the security manager
-     $securityManager = &atkGetSecurityManager();
+     $securityManager =</syntaxhighlight>

Leon: Fix destruction

2007-04-12T12:03:37Z

Fix destruction

@@ Line 47: / Line 47: @@
+   {
      // Get an instance of the security manager
-     $securityManager =</syntaxhighlight>
+     $securityManager = &atkGetSecurityManager();

Mg5Iur at 00:24, 12 April 2007

2007-04-12T00:24:34Z

@@ Line 47: / Line 47: @@
+   {
      // Get an instance of the security manager
-     $securityManager = &atkGetSecurityManager();
+     $securityManager =</syntaxhighlight>

bahtiar at 15:00, 14 January 2007

2007-01-14T15:00:55Z

← Older revision		Revision as of 15:00, 14 January 2007
Line 7:		Line 7:
	It is possible to set the conditions of a node-menuItem for appearing in the menu. This is also possible for the parent menuitem in a slightly different way.		It is possible to set the conditions of a node-menuItem for appearing in the menu. This is also possible for the parent menuitem in a slightly different way.

	<~~pre~~>		<syntaxhighlight lang="php">
	class mod_bestellingen extends atkModule {		class mod_bestellingen extends atkModule
	function getMenuItems() {		{
	// securtiyConditions is a 1 dimensional array containing		function getMenuItems()
	// pairs of nodename and the right the user should have for it		{
	// to appear in the menu.		// securtiyConditions is a 1 dimensional array containing
	$securityConditions = ~~Array~~(		// pairs of nodename and the right the user should have for it
	"bestellingen.orders","admin",		// to appear in the menu.
	"bestellingen.items","admin"		$securityConditions = array("bestellingen.orders","admin",
	);		"bestellingen.items","admin");

	// Parent menu item		// Parent menu item
	$this->menuitem("bestellingen","","main",$securityConditions);		$this->menuitem("bestellingen", "", "main", $securityConditions);

	// Add child items, only visible if parent menu item is visible		// Add child items, only visible if parent menu item is visible
	$this->menuitem(		$this->menuitem( "orders",
	"orders"		dispatch_url("bestellingen.orders", "admin"),
	, dispatch_url("bestellingen.orders", "admin")		"bestellingen",
	, "bestellingen"		array("bestellingen.orders","admin"));
	~~, Array~~("bestellingen.orders","admin"));

	$this->menuitem(		$this->menuitem( "items",
	"items"		dispatch_url("bestellingen.items", "admin"),
	, dispatch_url("bestellingen.items", "admin")		"bestellingen",
	, "bestellingen"		array("bestellingen.items","admin"));
	~~, Array~~("bestellingen.items","admin"));		}
	}		}
	</~~pre~~>		</syntaxhighlight>

	This is just an example of the getMenuItems function. If you use this you should of course also have a getNodes function with the proper rights.		This is just an example of the getMenuItems function. If you use this you should of course also have a getNodes function with the proper rights.
Line 42:		Line 41:
	I found out that a module will not appear in the mainmenu if there are no menuitems added. So another solution I came up with is checking if the user has rights on the node before adding it to the menu. You could also use your own custom ways to determine if a menuitem should be added. The example below does exactly the same as the example code above but is much more customizeable.		I found out that a module will not appear in the mainmenu if there are no menuitems added. So another solution I came up with is checking if the user has rights on the node before adding it to the menu. You could also use your own custom ways to determine if a menuitem should be added. The example below does exactly the same as the example code above but is much more customizeable.

	<~~pre~~>		<syntaxhighlight lang="php">
	class mod_orders extends atkModule {		class mod_orders extends atkModule
	function getMenuItems() {		{
	// Get an instance of the security manager		function getMenuItems()
	$securityManager = &atkGetSecurityManager();		{
			// Get an instance of the security manager
			$securityManager = &atkGetSecurityManager();

	// An array with all the nodes in this module		// An array with all the nodes in this module
	$nodes = ~~Array~~("order","items");		$nodes = array("order","items");

	// The hasAccess variabele indicates if the logged in user		// The hasAccess variabele indicates if the logged in user
	// has access to any of the nodes in this module.		// has access to any of the nodes in this module.

	$hasAccess = false; // Default is no access		$hasAccess = false; // Default is no access

	// If the user does have access to one of the nodes		// If the user does have access to one of the nodes
	// the menu items are added. The securityManager takes care of hiding		// the menu items are added. The securityManager takes care of hiding
	// specific nodes bases on the rights the user has.		// specific nodes bases on the rights the user has.
	foreach($nodes AS $nodeName) {		foreach($nodes AS $nodeName)
	if($securityManager->allowed("orders",$nodeName)) {		{
	// Accessible item found		if($securityManager->allowed("orders",$nodeName))
	$hasAccess = true;		{
	break;		// Accessible item found
	}		$hasAccess = true;
	}		break;
			}
			}

	if($hasAccess) {		if($hasAccess)
	$this->menuitem("orders");		{
			$this->menuitem("orders");

	// Loop through $nodes and add them to the menu		// Loop through $nodes and add them to the menu
	// this is just an example. In the real world		// this is just an example. In the real world
	// you probably would want different kind of minimal rights		// you probably would want different kind of minimal rights
	// and perhaps a different default view.		// and perhaps a different default view.
	foreach($nodes AS $nodeName) {		foreach($nodes AS $nodeName)
	$this->menuitem("order", dispatch_url("orders.".$nodeName, "admin"), "orders", ~~Array~~("orders.".$nodeName,"admin"));		{
	}		$this->menuitem("order", dispatch_url("orders.".$nodeName, "admin"), "orders",
	}		array("orders.".$nodeName,"admin"));
			}
			}
			}
	}		}
	</~~pre~~>		</syntaxhighlight>