dolibarr  20.0.0-beta
modExternalSite.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
3  * Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
4  * Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
5  * Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <https://www.gnu.org/licenses/>.
19  */
20 
29 include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
30 
31 
36 {
42  public function __construct($db)
43  {
44  $this->db = $db;
45 
46  // Id for module (must be unique).
47  // Use here a free id.
48  $this->numero = 100;
49 
50  // Family can be 'crm','financial','hr','projects','product','technic','other'
51  // It is used to sort modules in module setup page
52  $this->family = "interface";
53  // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
54  $this->name = preg_replace('/^mod/i', '', get_class($this));
55  // Module description used if translation string 'ModuleXXXDesc' not found (XXX is id value)
56  $this->description = "This module include an external web site or page into Dolibarr menus and view it into a Dolibarr frame.";
57  // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
58  $this->version = 'dolibarr';
59  // Key used in llx_const table to save module status enabled/disabled (XXX is id value)
60  $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
61  // Name of png file (without png) used for this module
62  $this->picto = 'website';
63  // Call to inside lang's file
64  $this->langfiles = array("externalsite");
65 
66  // Data directories to create when module is enabled
67  $this->dirs = array();
68 
69  // Config pages. Put here list of php page names stored in admmin directory used to setup module
70  $this->config_page_url = array("index.php@externalsite");
71 
72  // Dependencies
73  $this->depends = array(); // List of modules id that must be enabled if this module is enabled
74  $this->requiredby = array(); // List of modules id to disable if this one is disabled
75 
76  // Constants
77  // List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
78  // Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
79  // 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0)
80  // );
81  $this->const = array(0 => array('EXTERNALSITE_LABEL', 'chaine', 'ExternalSite', 'To declare label to use into external site menu entry', 0));
82 
83  // Boxes
84  $this->boxes = array(); // List of boxes
85  $r = 0;
86 
87  // Add here list of php file(s) stored in core/boxes that contains class to show a box.
88  // Example:
89  //$this->boxes[$r][1] = "myboxa.php";
90  //$r++;
91  //$this->boxes[$r][1] = "myboxb.php";
92  //$r++;
93 
94  // Permissions
95  $this->rights_class = 'externalsite'; // Permission key
96  $this->rights = array(); // Permission array used by this module
97 
98  $this->module_parts = array(
99  'moduleforexternal' => 1 // allow access to external users
100  );
101 
102  // Menus
103  //------
104  $r = 0;
105 
106  $this->menu[$r] = array(
107  'fk_menu' => 0,
108  'type' => 'top',
109  'titre' => '__[EXTERNALSITE_LABEL]__',
110  'prefix' => img_picto('', $this->picto, 'class="pictofixedwidth em092"'),
111  'mainmenu' => 'externalsite',
112  'url' => '/externalsite/frames.php',
113  'langs' => 'other',
114  'position' => 100,
115  'perms' => '',
116  'enabled' => '$conf->externalsite->enabled',
117  'target' => '',
118  'user' => 2
119  );
120  $r++;
121  }
122 }
Class DolibarrModules.
Description and activation class for module ExternalSite.
__construct($db)
Constructor.
print *****$script_file(".$version.") pid cd cd cd description as description
Only used if Module[ID]Desc translation string is not found.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
$conf db name
Only used if Module[ID]Name translation string is not found.
Definition: repair.php:126