dolibarr/htdocs/core/modules/modExternalSite.class.php
2024-09-06 20:28:06 +08:00

123 lines
4.7 KiB
PHP

<?php
/* Copyright (C) 2003 Rodolphe Quiedeville <rodolphe@quiedeville.org>
* Copyright (C) 2004-2012 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2005-2009 Regis Houssin <regis.houssin@inodbox.com>
* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* \defgroup externalsite Module externalsite
* \brief Module to include an external web site/tools into Dolibarr menu and into a frame page.
* \file htdocs/core/modules/modExternalSite.class.php
* \ingroup externalsite
* \brief Description and activation file for the module ExternalSite
*/
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
/**
* Description and activation class for module ExternalSite
*/
class modExternalSite extends DolibarrModules
{
/**
* Constructor. Define names, constants, directories, boxes, permissions
*
* @param DoliDB $db Database handler
*/
public function __construct($db)
{
$this->db = $db;
// Id for module (must be unique).
// Use here a free id.
$this->numero = 100;
// Family can be 'crm','financial','hr','projects','product','technic','other'
// It is used to sort modules in module setup page
$this->family = "interface";
// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
$this->name = preg_replace('/^mod/i', '', get_class($this));
// Module description used if translation string 'ModuleXXXDesc' not found (XXX is id value)
$this->description = "This module include an external web site or page into Dolibarr menus and view it into a Dolibarr frame.";
// Possible values for version are: 'development', 'experimental', 'dolibarr' or version
$this->version = 'dolibarr';
// Key used in llx_const table to save module status enabled/disabled (XXX is id value)
$this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
// Name of png file (without png) used for this module
$this->picto = 'website';
// Call to inside lang's file
$this->langfiles = array("externalsite");
// Data directories to create when module is enabled
$this->dirs = array();
// Config pages. Put here list of php page names stored in admmin directory used to setup module
$this->config_page_url = array("index.php@externalsite");
// Dependencies
$this->depends = array(); // List of modules id that must be enabled if this module is enabled
$this->requiredby = array(); // List of modules id to disable if this one is disabled
// Constants
// List of particular constants to add when module is enabled (key, 'chaine', value, desc, visible, 'current' or 'allentities', deleteonunactive)
// Example: $this->const=array(0=>array('MYMODULE_MYNEWCONST1','chaine','myvalue','This is a constant to add',1),
// 1=>array('MYMODULE_MYNEWCONST2','chaine','myvalue','This is another constant to add',0)
// );
$this->const = array(0 => array('EXTERNALSITE_LABEL', 'chaine', 'ExternalSite', 'To declare label to use into external site menu entry', 0));
// Boxes
$this->boxes = array(); // List of boxes
$r = 0;
// Add here list of php file(s) stored in core/boxes that contains class to show a box.
// Example:
//$this->boxes[$r][1] = "myboxa.php";
//$r++;
//$this->boxes[$r][1] = "myboxb.php";
//$r++;
// Permissions
$this->rights_class = 'externalsite'; // Permission key
$this->rights = array(); // Permission array used by this module
$this->module_parts = array(
'moduleforexternal' => 1 // allow access to external users
);
// Menus
//------
$r = 0;
$this->menu[$r] = array(
'fk_menu' => 0,
'type' => 'top',
'titre' => '__[EXTERNALSITE_LABEL]__',
'prefix' => img_picto('', $this->picto, 'class="pictofixedwidth em092"'),
'mainmenu' => 'externalsite',
'url' => '/externalsite/frames.php',
'langs' => 'other',
'position' => 100,
'perms' => '',
'enabled' => '$conf->externalsite->enabled',
'target' => '',
'user' => 2
);
$r++;
}
}