Module Flags - Revision history

Wayneh at 03:52, 11 September 2014

2014-09-11T03:52:56Z

← Older revision		Revision as of 03:52, 11 September 2014
Line 33:		Line 33:

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]] [[Relation Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]] \| [[Relation Flags]]
	</div>		</div>

Wayneh at 03:52, 11 September 2014

2014-09-11T03:52:37Z

← Older revision		Revision as of 03:52, 11 September 2014
Line 33:		Line 33:

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]] [[Relation Flags]]
	</div>		</div>

Wayneh: /* Available flags */

2014-09-11T02:57:58Z

Available flags

← Older revision		Revision as of 02:57, 11 September 2014
Line 23:		Line 23:

	;MF_SPECIFIC_1 - MF_SPECIFIC_5: Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		;MF_SPECIFIC_1 - MF_SPECIFIC_5: Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

			;MF_PRIMARY: Meta flag for DB

			;MF_UNIQUE: Meta flag for DB

			;MF_NOT_NUL: Meta flag for DB

			;MF_AUTO_INCREMENT: Meta flag for DB

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
	</div>		</div>

bahtiar: /* Available flags */

2008-08-18T21:17:16Z

Available flags

← Older revision		Revision as of 21:17, 18 August 2008
Line 22:		Line 22:
	;MF_NO_PRELOAD:This flag is similar to MF_REFERENCE, but goes one step further. Instead of just ignoring registerNode and menuitem calls, this flag disables loading of the module.inc file completely. This saves some performance if your using the module only for some of its source files. A module loaded with MF_NO_PRELOAD is completely in visible to the user, but you can still use its files using atkimport() etc., and you can create relationships with the nodes in this module.		;MF_NO_PRELOAD:This flag is similar to MF_REFERENCE, but goes one step further. Instead of just ignoring registerNode and menuitem calls, this flag disables loading of the module.inc file completely. This saves some performance if your using the module only for some of its source files. A module loaded with MF_NO_PRELOAD is completely in visible to the user, but you can still use its files using atkimport() etc., and you can create relationships with the nodes in this module.

	:MF_SPECIFIC_1 - MF_SPECIFIC_5: Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		;MF_SPECIFIC_1 - MF_SPECIFIC_5: Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
	</div>		</div>

bahtiar: /* Available flags */

2008-08-18T21:17:03Z

Available flags

← Older revision		Revision as of 21:17, 18 August 2008
Line 14:		Line 14:

	;MF_NOMENU: If you use a module from an external application because you need some of its functionality, you may not want to use the menuitems that this module registers. Or you may have your own way of accessing the functionality instead of through the menu.		;MF_NOMENU: If you use a module from an external application because you need some of its functionality, you may not want to use the menuitems that this module registers. Or you may have your own way of accessing the functionality instead of through the menu.
	In both these cases, you can use the MF_NOMENU flag in the module() call to prevent it		:In both these cases, you can use the MF_NOMENU flag in the module() call to prevent it

	;MF_NORIGHTS: Similar to MF_NOMENU, you may have defined your own access scheme, and you don't want to use the registerNode calls that the module provides in its module.inc file. By passing MF_NORIGHTS, all registerNode calls of the module will be ignored.		;MF_NORIGHTS: Similar to MF_NOMENU, you may have defined your own access scheme, and you don't want to use the registerNode calls that the module provides in its module.inc file. By passing MF_NORIGHTS, all registerNode calls of the module will be ignored.

bahtiar: /* Available flags */ formatting

2008-08-18T21:16:49Z

Available flags: formatting

← Older revision		Revision as of 21:16, 18 August 2008
Line 13:		Line 13:
	This is a list of flags that you can use:		This is a list of flags that you can use:

	~~===~~MF_NOMENU~~===~~		;MF_NOMENU: If you use a module from an external application because you need some of its functionality, you may not want to use the menuitems that this module registers. Or you may have your own way of accessing the functionality instead of through the menu.

	If you use a module from an external application because you need some of its functionality, you may not want to use the menuitems that this module registers. Or you may have your own way of accessing the functionality instead of through the menu.
	In both these cases, you can use the MF_NOMENU flag in the module() call to prevent it		In both these cases, you can use the MF_NOMENU flag in the module() call to prevent it

	~~===~~MF_NORIGHTS~~===~~		;MF_NORIGHTS: Similar to MF_NOMENU, you may have defined your own access scheme, and you don't want to use the registerNode calls that the module provides in its module.inc file. By passing MF_NORIGHTS, all registerNode calls of the module will be ignored.

	Similar to MF_NOMENU, you may have defined your own access scheme, and you don't want to use the registerNode calls that the module provides in its module.inc file. By passing MF_NORIGHTS, all registerNode calls of the module will be ignored.

	~~===MF_REFERENCE===~~

	~~If you don't need menuitems and privileges, you can pass MF_REFERENCE, which is an alias for using MF_NOMENU\|MF_NORIGHTS~~

	~~===MF_NO_PRELOAD===~~

	~~This flag is similar to~~ MF_REFERENCE~~, but goes one step further. Instead of just ignoring registerNode~~ and menuitem calls, this flag disables loading of the module.inc file completely. This saves some performance if your using the module only for some of its source files. A module loaded with MF_NO_PRELOAD is completely in visible to the user, ~~but~~ you can ~~still use its files~~ using ~~atkimport() etc., and you can create relationships with the nodes in this module.~~		;MF_REFERENCE: If you don't need menuitems and privileges, you can pass MF_REFERENCE, which is an alias for using MF_NOMENU\|MF_NORIGHTS

	~~===MF_SPECIFIC_1 - MF_SPECIFIC_5===~~		;MF_NO_PRELOAD:This flag is similar to MF_REFERENCE, but goes one step further. Instead of just ignoring registerNode and menuitem calls, this flag disables loading of the module.inc file completely. This saves some performance if your using the module only for some of its source files. A module loaded with MF_NO_PRELOAD is completely in visible to the user, but you can still use its files using atkimport() etc., and you can create relationships with the nodes in this module.

	Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		:MF_SPECIFIC_1 - MF_SPECIFIC_5: Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
	</div>		</div>

bahtiar: /* MF_SPECIFIC_1 - MF_SPECIFIC_5 */

2006-12-27T13:27:07Z

MF_SPECIFIC_1 - MF_SPECIFIC_5

← Older revision		Revision as of 13:27, 27 December 2006
Line 32:		Line 32:
	===MF_SPECIFIC_1 - MF_SPECIFIC_5===		===MF_SPECIFIC_1 - MF_SPECIFIC_5===

	Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to ~~MF_SPECIFIC_2~~ to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_5 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

	<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
	</div>		</div>

bahtiar at 13:24, 27 December 2006

2006-12-27T13:24:55Z

← Older revision		Revision as of 13:24, 27 December 2006
Line 34:		Line 34:
	Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_2 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_2 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

	<div style="background: ~~silver~~; padding: ~~5px 2px 5px 2px~~; margin-bottom: 20px;">		<div style="border:1px solid orange;width:90%;background-color:#FFFACD;padding:7px;margin-bottom:0.5em;margin-top:20px;">
	~~'''Atk Flags'''~~

	[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]		[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
	</div>		</div>

Darkelder: menu

2006-12-20T03:22:47Z

← Older revision		Revision as of 03:22, 20 December 2006
Line 33:		Line 33:

	Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_2 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.		Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_2 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.

			<div style="background: silver; padding: 5px 2px 5px 2px; margin-bottom: 20px;">
			'''Atk Flags'''

			[[ATK Attribute Flags]] \| [[Module Flags]] \| [[Node Flags]]
			</div>

bahtiar at 10:00, 24 June 2006

2006-06-24T10:00:29Z

New page

==Intro==

The module() method for loading modules has a $flags param. You can pass multiple flags by concatting them with a pipe symbol (|).

Example:

module("users", "/path/to/your/usersmodule/", MF_NO_PRELOAD);
or
module("users", "", MF_NO_PRELOAD); // if the module is in default location

==Available flags==

This is a list of flags that you can use:

===MF_NOMENU===

If you use a module from an external application because you need some of its functionality, you may not want to use the menuitems that this module registers. Or you may have your own way of accessing the functionality instead of through the menu.
In both these cases, you can use the MF_NOMENU flag in the module() call to prevent it

===MF_NORIGHTS===

Similar to MF_NOMENU, you may have defined your own access scheme, and you don't want to use the registerNode calls that the module provides in its module.inc file. By passing MF_NORIGHTS, all registerNode calls of the module will be ignored.

===MF_REFERENCE===

If you don't need menuitems and privileges, you can pass MF_REFERENCE, which is an alias for using MF_NOMENU|MF_NORIGHTS

===MF_NO_PRELOAD===

This flag is similar to MF_REFERENCE, but goes one step further. Instead of just ignoring registerNode and menuitem calls, this flag disables loading of the module.inc file completely. This saves some performance if your using the module only for some of its source files. A module loaded with MF_NO_PRELOAD is completely in visible to the user, but you can still use its files using atkimport() etc., and you can create relationships with the nodes in this module.

===MF_SPECIFIC_1 - MF_SPECIFIC_5===

Some modules may define additional flags that influence their behaviour. These modules can use MF_SPECIFIC_1 to MF_SPECIFIC_2 to define up to 5 custom flags. If a module has any custom flags is often documented in the documentation for the module in question.