phpBB

Development Wiki

Difference between revisions of "Mcp/info"

From phpBB Development Wiki

(MCP info page (stub))
 
m
Line 1: Line 1:
 
The '''mcp/info/''' directory is used to contain the install uninstall and title information for modes of modules installed in the [[Moderator Control Panel]]
 
The '''mcp/info/''' directory is used to contain the install uninstall and title information for modes of modules installed in the [[Moderator Control Panel]]
  
 +
==Example Info Page==
 
An example of a file within this directory should follow similar suit to this:
 
An example of a file within this directory should follow similar suit to this:
 
<php>/**  
 
<php>/**  

Revision as of 21:22, 24 January 2007

The mcp/info/ directory is used to contain the install uninstall and title information for modes of modules installed in the Moderator Control Panel

Example Info Page

An example of a file within this directory should follow similar suit to this:

/** 
*
* @author Original Author author@example.com
* @package mcp
* @version $Id: $
* @copyright (c) Original Author Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License 
*
*/

/**
* @package module_install
*/
class mcp_page_name_info
{
    function 
module()
    {
        return array(
            
'filename'    => 'mcp_page_name',
            
'title'        => 'MCP_PAGE_TITLE',
            
'version'    => '1.2.3',
            
'modes'        => array(
                
'mode1'        => array('title' => 'MCP_PAGE_MODE_ONE_TITLE''auth' => 'acl_m_,$id''cat' => array('MCP_PAGE_TITLE')),
                
'mode2'        => array('title' => 'MCP_PAGE_MODE_TWO_TITLE''auth' => 'acl_m_,$id''cat' => array('MCP_PAGE_TITLE')),
            ),
        );
    }

    function 
install()
    {
    }

    function 
uninstall()
    {
    }
}

Filename

'filename' => 'mcp_page_name',

Filename is the name of the file this info file is used for.

Title

'title' => 'MCP_PAGE_TITLE',

Title

Version

See Version Numbering

Modes

Mode Title

array('title' => 'MCP_PAGE_MODE_ONE_TITLE',

Mode Title

Mode Auth

'auth' => 'acl_m_,$id',

Mode Auth (permissions)

Mode Cat

'cat' => array('MCP_PAGE_TITLE')),

Parent Category

Functions

Leave the module(), install(), and uninstall() functions in place. These are necessary for installing and managing the modules by the admin.

This article is a stub. You can help in improving Olympus Documentation by expanding it.