Docs For Class atkModule

Home

Documentation home

Atk index

Docs For Class atkModule [ package: atk ]

Class: atkModule

Source Location: /modules/class.atkmodule.inc

Class atkModule

Class Overview

The atkModule abstract base class.

All modules in an ATK application should derive from this class, and override the methods of this abstract class as they see fit.

Located in /modules/class.atkmodule.inc [line 30]

Wiki documentation

Author(s):

Peter C. Verhage <peter@ibuildings.nl>

API Tags:

Abstract:

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
mod_meta	The meta module.
mod_test	Example module.

[ Top ]

Property Summary

static boolean	$s_isOverloader	We keep track if the node currently being instantiated is an overloader or not.
mixed	$m_name

[ Top ]

Method Summary

static string	getModuleScope()	Returns the current module scope.
static void	resetModuleScope()	Resets the current module scope.
static void	setModuleScope()	Set current module scope.
atkModule	atkModule()	Constructor. The module needs to register it's nodes overhere, create its menuitems etc.
array	getAdminLinks()	This method is similar to the getPreferenceLinks() method but instead will return links to (an) admin page(s) for this module. The array which will be returned have to be created with the adminlink() method.
array	getAttributes()	Returns an array with filenames of attributes that need to be included in order to let this module work properly.
string	getFixturePath()	Returns the fixture path for the given fixture.
array	getMenuItems()	This method returns an array with menu items that need to be available
array	getModifierFunctions()	Get the modifier functions for this node
string	getNodeFile()	Returns the node file for the given node.
void	getNodes()	Register nodes with their supported actions. Can be used for security etc.
array	getPreferenceLinks()	This method can be used to return an array similar to the menu array but with links to (a) preference(s) page(s) for this module. The items that will be returned have to be added with the preferencelink() method.
void	menuitem()	Create a new menu item, optionally configuring access control. This function can also be used to create separators, submenus and submenu items.
void	modifier()	Modifies the given node
new	&newNode()	Construct a new node. A module can override this method for it's own nodes.
node	nodeExists()	Checks if a certain node exists for this module.
string	nodeOverloader()	Returns the node overloader if it exists. Else it will just return the module/node name of the given node.

[ Top ]

Properties

static boolean $s_isOverloader = false [line 38]

We keep track if the node currently being instantiated is an overloader or not.

[ Top ]

mixed $m_name [line 40]

[ Top ]

Methods

static method getModuleScope [line 292]

static string getModuleScope(
)

Returns the current module scope.

API Tags:

Return:

current module

[ Top ]

static method resetModuleScope [line 303]

static void resetModuleScope(
)

Resets the current module scope.

[ Top ]

static method setModuleScope [line 280]

static void setModuleScope(
string
$module 
)

Set current module scope.

Parameters:

string

$module:

current module

[ Top ]

Constructor atkModule [line 47]

atkModule atkModule(
[String
$name = ""] 
)

Constructor. The module needs to register it's nodes overhere, create its menuitems etc.

Parameters:

String

$name:

The name of the module.

[ Top ]

getAdminLinks [line 140]

array getAdminLinks(
)

This method is similar to the getPreferenceLinks() method but instead will return links to (an) admin page(s) for this module. The array which will be returned have to be created with the adminlink() method.

API Tags:

Return:

with admin links for this module

[ Top ]

getAttributes [line 65]

array getAttributes(
)

Returns an array with filenames of attributes that need to be included in order to let this module work properly.

API Tags:

Return:

with attribute filenames

[ Top ]

getFixturePath [line 189]

string getFixturePath(
string
$fixture 
)

Returns the fixture path for the given fixture.

Parameters:

string

$fixture:

<module.fixture> string

API Tags:

Return:

path to fixture without extension

[ Top ]

getMenuItems [line 75]

array getMenuItems(
)

This method returns an array with menu items that need to be available

in the main ATK menu. This function returns the array created with the menuitem() method, and does not have to be extended!

API Tags:

Return:

with menu items for this module

Redefined in descendants as:

mod_meta::getMenuItems() : Return menu items.
mod_test::getMenuItems()

[ Top ]

getModifierFunctions [line 326]

array getModifierFunctions(

&$node, atkNode
$node 
)

Get the modifier functions for this node

Parameters:

atkNode	$node:
	&$node:

API Tags:

Return:

Array with modifier function names

[ Top ]

getNodeFile [line 178]

string getNodeFile(
string
$node 
)

Returns the node file for the given node.

Parameters:

string

$node:

the node type

API Tags:

Return:	node filename
See:	nodeFile()

[ Top ]

getNodes [line 56]

void getNodes(
)

Redefined in descendants as:

mod_meta::getNodes() : Return dummy node.
mod_test::getNodes()

[ Top ]

getPreferenceLinks [line 130]

array getPreferenceLinks(
)

This method can be used to return an array similar to the menu array but with links to (a) preference(s) page(s) for this module. The items that will be returned have to be added with the preferencelink() method.

API Tags:

Return:

with preference links for this module

[ Top ]

menuitem [line 117]

void menuitem(
[String
$name = ""], [String
$url = ""], [String
$parent = "main"], [mixed
$enable = 1], [int
$order = 0] 
)

Create a new menu item, optionally configuring access control. This function can also be used to create separators, submenus and submenu items.

Parameters:

String	$name:	The menuitem name. The name that is displayed in the userinterface can be influenced by putting "menu_something" in the language files, where 'something' is equal to the $name parameter. If "-" is specified as name, the item is a separator. In this case, the $url parameter should be empty.
String	$url:	The url to load in the main application area when the menuitem is clicked. If set to "", the menu is treated as a submenu (or a separator if $name equals "-"). The dispatch_url() method is a useful function to pass as this parameter.
String	$parent:	The parent menu. If omitted or set to "main", the item is added to the main menu.
mixed	$enable:	This parameter supports the following options: 1: menuitem is always enabled 0: menuitem is always disabled (this is useful when you want to use a function call to determine when a menuitem should be enabled. If the function returns 1 or 0, it can directly be passed to this method in the $enable parameter. array: when an array is passed, it should have the following format: array("node","action","node","action",...) When an array is passed, the menu checks user privileges. If the user has any of the node/action privileges, the menuitem is enabled. Otherwise, it's disabled.
int	$order:	The order in which the menuitem appears. If omitted, the items appear in the order in which they are added to the menu, with steps of 100. So, if you have a menu with default ordering and you want to place a new menuitem at the third position, pass 250 for $order.

[ Top ]

modifier [line 336]

void modifier(

&$node, atkNode
$node 
)

Modifies the given node

Parameters:

atkNode	$node:	Node to be modified
	&$node:

[ Top ]

newNode [line 202]

new &newNode(
atkNode
$node 
)

Construct a new node. A module can override this method for it's own nodes.

Parameters:

atkNode

$node:

the node type

API Tags:

Return:

node object

Redefined in descendants as:

mod_meta::newNode() : Construct a new meta node.

[ Top ]

nodeExists [line 313]

node nodeExists(
string
$node 
)

Checks if a certain node exists for this module.

Parameters:

string

$node:

the node type

API Tags:

Return:

exists?

Redefined in descendants as:

mod_meta::nodeExists() : Node exists?

[ Top ]

nodeOverloader [line 150]

string nodeOverloader(
string
$node 
)

Returns the node overloader if it exists. Else it will just return the module/node name of the given node.

Parameters:

string

$node:

module/node string

API Tags:

Return:

(overloader) module/node string

[ Top ]