Example module.inc file - Revision history

Mjs: improvements to menuitem()

2009-06-03T11:09:20Z

improvements to menuitem()

← Older revision		Revision as of 11:09, 3 June 2009
Line 44:		Line 44:
	== menuitem() ==		== menuitem() ==

	This function takes ~~two~~ parameters:		This function takes several parameters, many of which are optional:
	* The name of the menuitem (‘groupadmin’ in this case)
	* The url that should displayed when the user clicks the menu item. ''This can be any valid url.''

	A third ~~and~~ a fourth parameter can be ~~added as well~~.		* The name of the menuitem. This string is transformed slightly for display--in the case below, the user will see "User management", not "user_management".
			* The URL that should displayed when the user clicks the menu item. This can be any URL, though it's typically one generated by <tt>dispatch_url</tt>.
			* The third parameter, <tt>$parent</tt>, determines whether the menu item is a first- or second-level menu item. If <tt>$parent</tt> is absent or equal to the string "main", the menu item appears at the top level. If <tt>$parent</tt> is a string, then the menu item appears as a sub-menu of the named menu item.
			* The fourth parameter controls menu item visibility. (i.e. who can see the menu item--though note that access control is done separately! It's possible to be able to see a menu item, though not be able to access the page it links to.) This parameter can be either a boolean or an array.
			** '''boolean''' - If true, then the menu item is always displayed; if false it's never displayed.
			** '''array''' - The first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

			Example:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	function getMenuItems()		function getMenuItems()
	{		{
	$this->menuitem("~~groupadmin~~", dispatch_url("users.group", "admin"), ~~'''~~"main", array("users.group", "admin")~~'''~~);		$this->menuitem("user_management", dispatch_url("users.group", "admin"), "main", array("users.group", "admin"));
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	The third parameter, <tt>$parent</tt>, determines whether the menu item is a first- or second-level menu item. If <tt>$parent</tt> is absent or equal to the string"main", the menu item appears at the top level. If <tt>$parent</tt> is a string, then the menu item appears as a sub-menu of the named menu item.

	The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

bahtiar at 22:46, 1 September 2008

2008-09-01T22:46:49Z

← Older revision		Revision as of 22:46, 1 September 2008
Line 7:		Line 7:
	The module file is the most important part of the directory, as it will define the module. This file should be called 'module.inc' and should contain the following code:		The module file is the most important part of the directory, as it will define the module. This file should be called 'module.inc' and should contain the following code:

	<~~pre~~>		<syntaxhighlight lang="php">
	<?php		<?php

Line 26:		Line 26:

	?>		?>
	</~~pre~~>		</syntaxhighlight>

	== registerNode() ==		== registerNode() ==
Line 50:		Line 50:
	A third and a fourth parameter can be added as well.		A third and a fourth parameter can be added as well.

			<syntaxhighlight lang="php">
	function getMenuItems()		function getMenuItems()
	{		{
	$this->menuitem("groupadmin", dispatch_url("users.group", "admin"), '''"main", array("users.group", "admin")''');		$this->menuitem("groupadmin", dispatch_url("users.group", "admin"), '''"main", array("users.group", "admin")''');
	}		}
			</syntaxhighlight>

	The third parameter, <tt>$parent</tt>, determines whether the menu item is a first- or second-level menu item. If <tt>$parent</tt> is absent or equal to the string"main", the menu item appears at the top level. If <tt>$parent</tt> is a string, then the menu item appears as a sub-menu of the named menu item.		The third parameter, <tt>$parent</tt>, determines whether the menu item is a first- or second-level menu item. If <tt>$parent</tt> is absent or equal to the string"main", the menu item appears at the top level. If <tt>$parent</tt> is a string, then the menu item appears as a sub-menu of the named menu item.

	The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.		The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

Mjs: /* registerNode() */

2008-09-01T09:35:23Z

registerNode()

← Older revision		Revision as of 09:35, 1 September 2008
Line 30:		Line 30:
	== registerNode() ==		== registerNode() ==

	The <code>registerNode()</code> function call lets the access control components of ATK know what nodes exist, and what actions can be performed on those nodes. Without explicitly adding nodes and actions, there is no way for any user (other than the administrator) to perform actions on nodes or even--in many cases--to see that an action (link) is even available. Note that <code>registerNode()</code> does not determine who gets to do what; it only ~~defines~~ which actions are available. (Who gets to do what is controlled by ATK's group management interface, and stored in the <code>access</code> table in the database.)		The <code>registerNode()</code> function call lets the access control components of ATK know what nodes exist, and what actions can be performed on those nodes. Without explicitly adding nodes and actions, there is no way for any user (other than the administrator) to perform actions on nodes or even--in many cases--to see that an action (link) is even available. Note that <code>registerNode()</code> does not determine who gets to do what; only which actions are available. (Who gets to do what is controlled by ATK's group management interface, and stored in the <code>access</code> table in the database.)

	<code>registerNode()</code> has two arguments: a node name (string) and an array of actions:		<code>registerNode()</code> has two arguments: a node name (string) and an array of actions:
Line 39:		Line 39:

	This tells ATK that the "admin", "add", "edit" and "delete" actions are valid operations to perform on a "user.student" node.		This tells ATK that the "admin", "add", "edit" and "delete" actions are valid operations to perform on a "user.student" node.

			(Note that removing registerNode() calls from <code>module.inc</code> does not disable those actions! It seems that the algorithm to figure out who gets to do what is something like: (1) use reflection to figure out what actions are possible; (2) look through the <tt>access</tt> table to see if the current user (via their group) is allowed to perform the action. i.e. registerNode() determines which actions are displayed by the admin interface, but not which actions are possible. Another implication of this approach is that actions must be removed from both registerNode() and the access table for them to be completely removed from the application. [Text should be cleaned up, integrated into the description above.])

	== menuitem() ==		== menuitem() ==

Mjs: /* registerNode() */

2008-08-30T15:52:28Z

registerNode()

← Older revision		Revision as of 15:52, 30 August 2008
Line 30:		Line 30:
	== registerNode() ==		== registerNode() ==

	The <code>registerNode()</code> function call lets the access control components of ATK know what nodes exist, and what actions can be performed on those nodes. Without explicitly adding nodes and actions, there is no way for any user (other than the administrator) to perform actions on nodes or even--in many cases--to see that an action (link) is even available. ~~Node~~ that <code>registerNode()</code> does not determine who gets to do what; it only defines which actions are available. (Who gets to do what is controlled by ATK's group management interface, and stored in the <code>access</code> table in the database.)		The <code>registerNode()</code> function call lets the access control components of ATK know what nodes exist, and what actions can be performed on those nodes. Without explicitly adding nodes and actions, there is no way for any user (other than the administrator) to perform actions on nodes or even--in many cases--to see that an action (link) is even available. Note that <code>registerNode()</code> does not determine who gets to do what; it only defines which actions are available. (Who gets to do what is controlled by ATK's group management interface, and stored in the <code>access</code> table in the database.)

	<code>registerNode()</code> has two arguments: a node name (string) and an array of actions:		<code>registerNode()</code> has two arguments: a node name (string) and an array of actions:

Mjs: /* registerNode() */

2008-08-29T17:23:39Z

registerNode()

← Older revision		Revision as of 17:23, 29 August 2008
Line 30:		Line 30:
	== registerNode() ==		== registerNode() ==

	~~???~~		The <code>registerNode()</code> function call lets the access control components of ATK know what nodes exist, and what actions can be performed on those nodes. Without explicitly adding nodes and actions, there is no way for any user (other than the administrator) to perform actions on nodes or even--in many cases--to see that an action (link) is even available. Node that <code>registerNode()</code> does not determine who gets to do what; it only defines which actions are available. (Who gets to do what is controlled by ATK's group management interface, and stored in the <code>access</code> table in the database.)

			<code>registerNode()</code> has two arguments: a node name (string) and an array of actions:

			<syntaxhighlight lang="php">
			registerNode("user.student", array("admin", "add", "edit", "delete"));
			</syntaxhighlight>

			This tells ATK that the "admin", "add", "edit" and "delete" actions are valid operations to perform on a "user.student" node.

	== menuitem() ==		== menuitem() ==

Mjs at 23:04, 26 August 2008

2008-08-26T23:04:39Z

← Older revision		Revision as of 23:04, 26 August 2008
Line 27:		Line 27:
	?>		?>
	</pre>		</pre>

			== registerNode() ==

			???

			== menuitem() ==

	This function takes two parameters:		This function takes two parameters:
Line 39:		Line 45:
	}		}

	The third parameter, $parent, determines whether the menu item is a first- or second-level menu item. If $parent is absent or "main", the menu item appears at the top level. If $parent is a string, then the menu item appears as a sub-menu of the named menu item.		The third parameter, <tt>$parent</tt>, determines whether the menu item is a first- or second-level menu item. If <tt>$parent</tt> is absent or equal to the string"main", the menu item appears at the top level. If <tt>$parent</tt> is a string, then the menu item appears as a sub-menu of the named menu item.

	The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.		The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

Mjs at 17:19, 26 August 2008

2008-08-26T17:19:36Z

← Older revision		Revision as of 17:19, 26 August 2008
Line 32:		Line 32:
	* The url that should displayed when the user clicks the menu item. ''This can be any valid url.''		* The url that should displayed when the user clicks the menu item. ''This can be any valid url.''

			A third and a fourth parameter can be added as well.
	A third and a fourth ~~paramerer~~ can be added as well.

	function getMenuItems()		function getMenuItems()
	{		{
	$this->menuitem("groupadmin", dispatch_url("users.group", "admin"), '''"main", array("users.group", "admin")''');		$this->menuitem("groupadmin", dispatch_url("users.group", "admin"), '''"main", array("users.group", "admin")''');
			}

	~~''Note: if we want to specify the fourth~~ parameter, ~~we can’t skip~~ the second ~~and~~ the ~~third~~. ~~Therefore~~, ~~you can now see that we put~~ the ~~'groupadmin'~~ menu-~~item in~~ the ~~main~~ menu.''		The third parameter, $parent, determines whether the menu item is a first- or second-level menu item. If $parent is absent or "main", the menu item appears at the top level. If $parent is a string, then the menu item appears as a sub-menu of the named menu item.

	The fourth parameter ~~can be three things:~~		The fourth parameter controls menu item visibility. (i.e. who has access to the menu item.) If true, then the menu item is always displayed; if false it's never displayed. If it's an array, the first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.
	* True: menu item is always displayed
	* False: menu-item is never displayed.
	* An array ~~with node/action pairs:~~
	~~The~~ first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

Jeroenvs at 07:36, 5 October 2006

2006-10-05T07:36:59Z

← Older revision		Revision as of 07:36, 5 October 2006
Line 27:		Line 27:
	?>		?>
	</pre>		</pre>

			This function takes two parameters:
			* The name of the menuitem (‘groupadmin’ in this case)
			* The url that should displayed when the user clicks the menu item. ''This can be any valid url.''


			A third and a fourth paramerer can be added as well.

			function getMenuItems()
			{
			$this->menuitem("groupadmin", dispatch_url("users.group", "admin"), '''"main", array("users.group", "admin")''');

			''Note: if we want to specify the fourth parameter, we can’t skip the second and the third. Therefore, you can now see that we put the 'groupadmin' menu-item in the main menu.''

			The fourth parameter can be three things:
			* True: menu item is always displayed
			* False: menu-item is never displayed.
			* An array with node/action pairs:
			The first element of the array must be a node (identified by modulename.nodename notation), the second element is an action. The third can be a node again, the fourth an action, and so on. If the user has the right to perform one of these actions, he will see the menu-item. In this case, the menu is displayed if the user has the ‘admin’ right on the 'users.group' node.

bahtiar: CompleteModuleFile moved to Example module.inc file

2006-07-13T06:23:55Z

CompleteModuleFile moved to Example module.inc file

← Older revision	Revision as of 06:23, 13 July 2006
(No difference)

bahtiar at 06:23, 13 July 2006

2006-07-13T06:23:34Z

← Older revision		Revision as of 06:23, 13 July 2006
Line 20:		Line 20:
	function getMenuItems()		function getMenuItems()
	{		{
	menuitem("groupadmin", dispatch_url("users.group", "admin"));		$this->menuitem("groupadmin", dispatch_url("users.group", "admin"));
	}		}

Line 27:		Line 27:
	?>		?>
	</pre>		</pre>

	~~Original Poser: ivo~~