Fix: example

This commit is contained in:
Laurent Destailleur 2012-02-20 19:57:16 +01:00
parent 58d1a042a5
commit 4631c97733

View File

@ -1,6 +1,6 @@
<?php <?php
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org> /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2011 Laurent Destailleur <eldy@users.sourceforge.net> * Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2010 Regis Houssin <regis@dolibarr.fr> * Copyright (C) 2005-2010 Regis Houssin <regis@dolibarr.fr>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -18,19 +18,18 @@
*/ */
/** /**
* \defgroup mymodule Module MyModule * \defgroup mymodule Module MyModule
* \brief Example of a module descriptor. * \brief Example of a module descriptor.
* Such a file must be copied into htdocs/mymodule/core/modules directory. * Such a file must be copied into htdocs/mymodule/core/modules directory.
* \file htdocs/mymodule/core/modules/modMyModule.class.php * \file htdocs/mymodule/core/modules/modMyModule.class.php
* \ingroup mymodule * \ingroup mymodule
* \brief Description and activation file for module MyModule * \brief Description and activation file for module MyModule
*/ */
include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php"); include_once(DOL_DOCUMENT_ROOT ."/core/modules/DolibarrModules.class.php");
/** /**
* \class modMyModule * Description and activation class for module MyModule
* \brief Description and activation class for module MyModule
*/ */
class modMyModule extends DolibarrModules class modMyModule extends DolibarrModules
{ {
@ -172,46 +171,46 @@ class modMyModule extends DolibarrModules
// Add here entries to declare new menus // Add here entries to declare new menus
// //
// Example to declare a new Top Menu entry and its Left menu entry: // Example to declare a new Top Menu entry and its Left menu entry:
// $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu // $this->menu[$r]=array( 'fk_menu'=>0, // Put 0 if this is a top menu
// 'type'=>'top', // This is a Top menu entry // 'type'=>'top', // This is a Top menu entry
// 'titre'=>'MyModule top menu', // 'titre'=>'MyModule top menu',
// 'mainmenu'=>'mymodule', // 'mainmenu'=>'mymodule',
// 'leftmenu'=>'mymodule', // 'leftmenu'=>'mymodule',
// 'url'=>'/mymodule/pagetop.php', // 'url'=>'/mymodule/pagetop.php',
// 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory. // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
// 'position'=>100, // 'position'=>100,
// 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. // 'enabled'=>'$conf->mymodule->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
// 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
// 'target'=>'', // 'target'=>'',
// 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
// $r++; // $r++;
// $this->menu[$r]=array( 'fk_menu'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry) // $this->menu[$r]=array( 'fk_menu'=>'r=0', // Use r=value where r is index key used for the parent menu entry (higher parent must be a top menu entry)
// 'type'=>'left', // This is a Left menu entry // 'type'=>'left', // This is a Left menu entry
// 'titre'=>'MyModule left menu', // 'titre'=>'MyModule left menu',
// 'mainmenu'=>'mymodule', // 'mainmenu'=>'mymodule',
// 'leftmenu'=>'mymodule', // 'leftmenu'=>'mymodule',
// 'url'=>'/mymodule/pagelevel1.php', // 'url'=>'/mymodule/pagelevel1.php',
// 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory. // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
// 'position'=>100, // 'position'=>100,
// 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. // 'enabled'=>'$conf->mymodule->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled.
// 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
// 'target'=>'', // 'target'=>'',
// 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
// $r++; // $r++;
// //
// Example to declare a Left Menu entry into an existing Top menu entry: // Example to declare a Left Menu entry into an existing Top menu entry:
// $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=mainmenucode', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy' // $this->menu[$r]=array( 'fk_menu'=>'fk_mainmenu=mainmenucode', // Use 'fk_mainmenu=xxx' or 'fk_mainmenu=xxx,fk_leftmenu=yyy'
// 'type'=>'left', // This is a Left menu entry // 'type'=>'left', // This is a Left menu entry
// 'titre'=>'MyModule left menu', // 'titre'=>'MyModule left menu',
// 'mainmenu'=>'mainmenucode', // 'mainmenu'=>'mainmenucode',
// 'leftmenu'=>'mymodule', // 'leftmenu'=>'mymodule',
// 'url'=>'/mymodule/pagelevel2.php', // 'url'=>'/mymodule/pagelevel2.php',
// 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory. // 'langs'=>'mylangfile', // Lang file to use (without .lang) by module. File must be in langs/code_CODE/ directory.
// 'position'=>100, // 'position'=>100,
// 'enabled'=>'1', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected. // 'enabled'=>'$conf->mymodule->enabled', // Define condition to show or hide menu entry. Use '$conf->mymodule->enabled' if entry must be visible if module is enabled. Use '$leftmenu==\'system\'' to show if leftmenu system is selected.
// 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules // 'perms'=>'1', // Use 'perms'=>'$user->rights->mymodule->level1->level2' if you want your menu with a permission rules
// 'target'=>'', // 'target'=>'',
// 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both // 'user'=>2); // 0=Menu for internal users, 1=external users, 2=both
// $r++; // $r++;