Docs For Class mod

Home

Documentation home

Atk index

Docs For Class mod_meta [ package: atk ]

Class: mod_meta

Source Location: /meta/module.inc

Class mod_meta

Class Overview

The meta module.

To enable this module just add the following line in the config.modules.inc file:

module("meta", atkconfig("atkroot")."/atk/meta");

If you are not logged in as administrator you might have to do so to get access to the module and/or give yourself the proper access rights.

Located in /meta/module.inc [line 34]

Wiki documentation

atkModule
   |
   --mod_meta

Author(s):

Peter C. Verhage <peter@achievo.org>

Information Tags:

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkModule atkModule::$m_name atkModule::$s_isOverloader	Inherited From atkModule atkModule::atkModule() Constructor. The module needs to register it's nodes overhere, create its menuitems etc. atkModule::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. atkModule::getAttributes() Returns an array with filenames of attributes that need to be included in order to let this module work properly. atkModule::getFixturePath() Returns the fixture path for the given fixture. atkModule::getMenuItems() This method returns an array with menu items that need to be available atkModule::getModifierFunctions() Get the modifier functions for this node atkModule::getModuleScope() Returns the current module scope. atkModule::getNodeFile() Returns the node file for the given node. atkModule::getNodes() Register nodes with their supported actions. Can be used for security etc. atkModule::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. atkModule::menuitem() Create a new menu item, optionally configuring access control. This function can also be used to create separators, submenus and submenu items. atkModule::modifier() Modifies the given node atkModule::newNode() Construct a new node. A module can override this method for it's own nodes. atkModule::nodeExists() Checks if a certain node exists for this module. atkModule::nodeOverloader() Returns the node overloader if it exists. Else it will just return the module/node name of the given node. atkModule::resetModuleScope() Resets the current module scope. atkModule::setModuleScope() Set current module scope.

Inherited Properties

Inherited Methods

Inherited From atkModule

atkModule::$m_name

atkModule::$s_isOverloader

Inherited From atkModule

atkModule::atkModule()

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

atkModule::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.

atkModule::getAttributes()

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

atkModule::getFixturePath()

Returns the fixture path for the given fixture.

atkModule::getMenuItems()

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

atkModule::getModifierFunctions()

Get the modifier functions for this node

atkModule::getModuleScope()

Returns the current module scope.

atkModule::getNodeFile()

Returns the node file for the given node.

atkModule::getNodes()

Register nodes with their supported actions. Can be used for security etc.

atkModule::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.

atkModule::menuitem()

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

atkModule::modifier()

Modifies the given node

atkModule::newNode()

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

atkModule::nodeExists()

Checks if a certain node exists for this module.

atkModule::nodeOverloader()

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

atkModule::resetModuleScope()

Resets the current module scope.

atkModule::setModuleScope()

Set current module scope.

[ Top ]

Method Summary

void	getMenuItems()	Return menu items.
void	getNodes()	Return dummy node.
void	initMetaPolicy()	Initialize meta policy.
new	newNode()	Construct a new meta node.
void	nodeExists()	Node exists?

[ Top ]

Properties

Methods

getMenuItems [line 47]

void getMenuItems(
)

Return menu items.

Redefinition of:

atkModule::getMenuItems(): This method returns an array with menu items that need to be available

[ Top ]

getNodes [line 39]

void getNodes(
)

Return dummy node.

Redefinition of:

atkModule::getNodes(): Register nodes with their supported actions. Can be used for security etc.

[ Top ]

initMetaPolicy [line 94]

void initMetaPolicy(

$policy 
)

Initialize meta policy.

Parameters:

$policy:

[ Top ]

newNode [line 65]

new newNode(
$node
$node 
)

Construct a new meta node.

Parameters:

$node

$node:

the node type

API Tags:

Return:

node object

Redefinition of:

atkModule::newNode(): Construct a new node. A module can override this method for it's own nodes.

[ Top ]

nodeExists [line 83]

void nodeExists(

$node 
)

Node exists?

Parameters:

$node:

Redefinition of:

atkModule::nodeExists(): Checks if a certain node exists for this module.

[ Top ]